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 powodująca niezgodność lub niezgodność | Kluczowa |
Domyślnie włączone na platformie .NET 9 | Nie. |
Przyczyna
Nazwa zdarzenia zaczyna się od "Before" lub "After".
Opis reguły
Nazwy zdarzeń powinny opisywać akcję, która wywołuje zdarzenie. Nazwa powiązanych zdarzeń, które są wywoływane w określonej kolejności, używa czasu teraźniejszego lub przeszłego, aby wskazać względne położenie akcji w sekwencji. Na przykład podczas nazewnictwa pary zdarzeń zgłaszanych podczas zamykania zasobu można nazwać je "Zamykanie" i "Zamknięte", zamiast "BeforeClose" i "AfterClose".
Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego 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 korzystała z bieżącego lub wcześniejszego napiętego czasownika.
Kiedy pomijać ostrzeżenia
Nie pomijaj ostrzeżeń dla tej reguły.