CA1713 Zdarzenia nie powinny posiadać prefiksów Before ani After

Właściwości	Wartość
Identyfikator reguły	CA1713
Tytuł	Zdarzenia nie powinny mieć prefiksu „before” ani „after”
Kategoria	Nazewnictwo
Poprawka łamiąca lub nienaruszająca	Przełomowe
Domyślnie włączone na platformie .NET 10	Nie.
Zastosowane języki	C# i Visual Basic

Przyczyna

Nazwa zdarzenia zaczyna się od "Before" lub "After".

Opis reguły

Nazwy zdarzeń powinny opisywać akcję, która wywołuje zdarzenie. Nazwy powiązanych zdarzeń, które są wywoływane w określonej kolejności, powinny używać czasu teraźniejszego lub przeszłego do wskazania względnego położenia w sekwencji działań. Na przykład, wybierając nazwy dla pary zdarzeń uruchamianych podczas zamykania zasobu, lepiej użyć nazw takich jak "Zamykanie" i "Zamknięte", zamiast "BeforeClose" i "AfterClose".

Konwencje nazewnictwa zapewniają spójny format dla bibliotek działających w środowisku uruchomieniowym języka wspólnego. Zmniejsza to krzywą uczenia wymaganą dla nowych bibliotek oprogramowania i zwiększa pewność klienta, że biblioteka została opracowana przez kogoś, kto ma doświadczenie w tworzeniu kodu zarządzanego.

Jak naprawić naruszenia

Usuń prefiks z nazwy zdarzenia i rozważ zmianę nazwy tak, aby używała czasu teraźniejszego lub przeszłego czasownika.

Example

public class Session
{
    // This code violates the rule.
    public event EventHandler? BeforeClose;
    public event EventHandler? AfterClose;

    // This code satisfies the rule.
    public event EventHandler? Closing;
    public event EventHandler? Closed;
}

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły.