CA1070: Não declarar campos de evento como virtuais
| Property | valor |
|---|---|
| ID da regra | CA1070 |
| Título | Não declare campos de evento como virtuais |
| Categoria | Desenho |
| A correção está quebrando ou não quebrando | Quebrando |
| Habilitado por padrão no .NET 8 | Como sugestão |
Motivo
Um evento semelhante a um campo foi declarado como virtual.
Por padrão, essa regra examina apenas tipos visíveis externamente, mas isso é configurável.
Descrição da regra
Siga estas diretrizes de design do .NET para gerar eventos de classe base em classes derivadas. Não declare eventos virtuais em uma classe base. Eventos substituídos em uma classe derivada têm comportamento indefinido. O compilador C# não manipula isso corretamente e é imprevisível se um assinante do evento derivado realmente estará assinando o evento de classe base.
using System;
public class C
{
// CA1070: Event 'ThresholdReached' should not be declared virtual.
public virtual event EventHandler ThresholdReached;
}
Como corrigir violações
Siga estas diretrizes de design do .NET e evite eventos semelhantes a campos virtuais.
Quando suprimir avisos
Se o evento for uma API pública visível externamente que já faz parte de uma biblioteca enviada, é seguro suprimir um aviso dessa regra para evitar uma alteração de quebra para os consumidores da biblioteca.
Suprimir um aviso
Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.
#pragma warning disable CA1070
// The code that's violating the rule is on this line.
#pragma warning restore CA1070
Para desabilitar a regra para um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1070.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
Configurar código para análise
Use a opção a seguir para configurar em quais partes da base de código executar essa regra.
Você pode configurar essa opção apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Design) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da regra de qualidade de código.
Incluir superfícies de API específicas
Você pode configurar em quais partes da sua base de código executar essa regra, com base em sua acessibilidade. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
