Partilhar via


CA1713: Os eventos não devem ter os prefixos antes ou depois

Propriedade valor
ID da regra CA1713
Título Os eventos não devem ter o prefixo "antes" ou "depois".
Categoria Atribuição de nomes
A correção causa interrupção ou não Interrupção
Habilitado por padrão no .NET 10 Não
Línguas aplicáveis C# e Visual Basic

Motivo

O nome de um evento começa com 'Antes' ou 'Depois'.

Descrição da regra

Os nomes dos eventos devem descrever a ação que gera o evento. Para nomear eventos relacionados que são gerados em uma sequência específica, use o tempo presente ou passado para indicar a posição relativa na sequência de ações. Por exemplo, ao nomear um par de eventos que é acionado ao fechar um recurso, pode-se nomeá-los 'Fechando' e 'Fechado', em vez de 'BeforeClose' e 'AfterClose'.

As convenções de nomenclatura fornecem uma aparência comum para bibliotecas que visam o Common Language Runtime. Isso reduz a curva de aprendizado necessária para novas bibliotecas de software e aumenta a confiança do cliente de que a biblioteca foi desenvolvida por alguém com experiência no desenvolvimento de código gerenciado.

Como corrigir violações

Remova o prefixo do nome do evento e considere alterar o nome para usar o tempo presente ou passado de um verbo.

Example

public class Session
{
    // This code violates the rule.
    public event EventHandler? BeforeClose;
    public event EventHandler? AfterClose;

    // This code satisfies the rule.
    public event EventHandler? Closing;
    public event EventHandler? Closed;
}

Quando suprimir avisos

Não suprima um aviso desta regra.