CA1070: Deklarujte pole událostí jako virtuální
| Vlastnost | Hodnota |
|---|---|
| ID pravidla | CA1070 |
| Název | Nedeklarujte pole událostí jako virtuální. |
| Kategorie | Návrh |
| Oprava způsobující chybu nebo chybu způsobující chybu | Narušující |
| Povoleno ve výchozím nastavení v .NET 8 | Jako návrh |
Příčina
Událost podobná poli byla deklarována jako virtuální.
Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy, ale dá se konfigurovat.
Popis pravidla
Pokud chcete v odvozených třídách vyvolat události základní třídy, postupujte podle těchto pokynů pro návrh .NET. Neeklarujte virtuální události v základní třídě. Přepsané události v odvozené třídě mají nedefinované chování. Kompilátor jazyka C# tento problém nezpracuje správně a je nepředvídatelné, jestli se odběratel odvozené události skutečně přihlašuje k odběru události základní třídy.
using System;
public class C
{
// CA1070: Event 'ThresholdReached' should not be declared virtual.
public virtual event EventHandler ThresholdReached;
}
Jak opravit porušení
Postupujte podle těchto pokynů pro návrh .NET a vyhněte se událostem podobným virtuálním polím.
Kdy potlačit upozornění
Pokud je událost externě viditelným veřejným rozhraním API, které je již součástí dodané knihovny, je bezpečné potlačit upozornění z tohoto pravidla, aby se zabránilo zásadní změně pro příjemce knihovny.
Potlačení upozornění
Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.
#pragma warning disable CA1070
// The code that's violating the rule is on this line.
#pragma warning restore CA1070
Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.
[*.{cs,vb}]
dotnet_diagnostic.CA1070.severity = none
Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.
Konfigurace kódu pro analýzu
Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.
Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Návrh), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.
Zahrnutí konkrétních povrchů rozhraní API
Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:
dotnet_code_quality.CAXXXX.api_surface = private, internal
