CA1713: Eventos não devem ter o prefixo anterior ou posterior
Property | Valor |
---|---|
ID da regra | CA1713 |
Título | Eventos não devem ter o prefixo anterior ou posterior |
Categoria | Nomenclatura |
Correção interruptiva ou sem interrupção | Quebra |
Habilitado por padrão no .NET 8 | Não |
Causa
O nome de um evento começa com "Before" ou "After".
Descrição da regra
Os nomes dos eventos devem descrever a ação que gera o evento. Para nomear eventos relacionados acionados em uma sequência específica, use o presente ou o pretérito para indicar a posição relativa na sequência de ações. Por exemplo, ao nomear um par de eventos gerados ao fechar um recurso, você pode nomeá-lo como 'Closing' e 'Closed', em vez de 'BeforeClose' e 'AfterClose'.
As convenções de nomenclatura fornecem uma aparência comum para bibliotecas destinadas a 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.
Quando suprimir avisos
Não suprima um aviso nessa regra.