CA1070: Nie deklaruj pól zdarzeń jako wirtualne
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | CA1070 |
| Tytuł | Nie deklaruj pól zdarzeń jako wirtualnych |
| Kategoria | Projekt |
| Poprawka powodująca niezgodność lub niezgodność | Kluczowa |
| Domyślnie włączone na platformie .NET 9 | Jako sugestia |
Przyczyna
Zdarzenie podobne do pola zostało zadeklarowane jako wirtualne.
Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.
Opis reguły
Postępuj zgodnie z tymi wytycznymi projektowymi platformy .NET, aby zgłaszać zdarzenia klasy bazowej w klasach pochodnych. Nie deklaruj zdarzeń wirtualnych w klasie bazowej. Przesłonięte zdarzenia w klasie pochodnej mają niezdefiniowane zachowanie. Kompilator języka C# nie obsługuje tego poprawnie i jest nieprzewidywalny, czy subskrybent zdarzenia pochodnego rzeczywiście subskrybuje zdarzenie klasy bazowej.
using System;
public class C
{
// CA1070: Event 'ThresholdReached' should not be declared virtual.
public virtual event EventHandler ThresholdReached;
}
Jak naprawić naruszenia
Postępuj zgodnie z tymi wytycznymi projektowymi platformy .NET i unikaj zdarzeń podobnych do pól wirtualnych.
Kiedy pomijać ostrzeżenia
Jeśli zdarzenie jest zewnętrznie widocznym publicznym interfejsem API, który jest już częścią dostarczonej biblioteki, można bezpiecznie pominąć ostrzeżenie z tej reguły, aby uniknąć zmiany powodującej niezgodność dla użytkowników bibliotek.
Pomijanie ostrzeżenia
Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.
#pragma warning disable CA1070
// The code that's violating the rule is on this line.
#pragma warning restore CA1070
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.CA1070.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.
Konfigurowanie kodu do analizowania
Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.
Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (Projekt), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.
Uwzględnij określone powierzchnie interfejsu API
Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:
dotnet_code_quality.CAXXXX.api_surface = private, internal
