CA1070: Non dichiarare campi evento come virtuali

  • Articolo
Proprietà valore
ID regola CA1070
Title Non dichiarare i campi evento come virtuali
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 Come suggerimento

Causa

Un evento simile a un campo è stato dichiarato come virtuale.

Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.

Descrizione regola

Seguire queste linee guida di progettazione .NET per generare eventi di classe di base nelle classi derivate. Non dichiarare eventi virtuali in una classe di base. Gli eventi sottoposti a override in una classe derivata hanno un comportamento non definito. Il compilatore C# non gestisce correttamente questa situazione ed è imprevedibile se un sottoscrittore dell'evento derivato sottoscriverà effettivamente l'evento della classe base.

using System;
public class C
{
    // CA1070: Event 'ThresholdReached' should not be declared virtual.
    public virtual event EventHandler ThresholdReached;
}

Come correggere le violazioni

Seguire queste linee guida di progettazione .NET ed evitare eventi di tipo campo virtuale.

Quando eliminare gli avvisi

Se l'evento è un'API pubblica visibile esternamente che fa già parte di una libreria fornita, è possibile eliminare un avviso da questa regola per evitare una modifica di rilievo per i consumer della libreria.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

#pragma warning disable CA1070
// The code that's violating the rule is on this line.
#pragma warning restore CA1070

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

[*.{cs,vb}]
dotnet_diagnostic.CA1070.severity = none

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (Progettazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Vedi anche