CA1711: Identyfikatory powinny mieć poprawny przyrostek
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
Kategoria |
Microsoft.Naming |
Zmiana kluczowa |
Kluczowa |
Przyczyna
Identyfikator ma niepoprawny przyrostek.
Opis reguły
Zgodnie z konwencją, tylko nazwy typów, które rozszerzają pewne typy podstawowe lub implementują pewne interfejsy lub typy dziedziczące po tych typach, powinny kończyć się określonym, zarezerwowany przyrostkiem.Inne nazwy typów nie powinny używać tych zarezerwowanych sufiksów.
W poniższej tabeli przedstawiono listę zarezerwowanych przyrostków i typów podstawowych oraz interfejsów, z którymi są one skojarzone.
Przyrostek |
Typ podstawowy/interfejs |
|---|---|
Attribute |
|
Collection |
|
Dictionary |
|
EventArgs |
|
EventHandler |
Obiekt delegowany obsługi zdarzeń. |
Exception |
|
Permission |
|
Queue |
|
Stack |
|
Stream |
Ponadto, następujące przyrostki nie powinny być używane:
Delegate
Enum
Impl - zamiast niego użyj "Core"
Ex lub podobny przyrostek do odróżniania wcześniejszej wersji tego samego typu
Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych docelowo dla środowiska uruchomieniowego CLR.Zmniejsza to krzywą zdobywania wiedzy, która jest wymagana dla nowych bibliotek oprogramowania i zwiększa ufność klientów w to, że biblioteka została opracowana przez osobę, która ma doświadczenie w rozwijaniu kodu zarządzanego.
Jak naprawić naruszenia
Usuń przyrostek z nazwy typu.
Kiedy pominąć ostrzeżenia
Nie pomijaj ostrzeżeń dotyczących tej zasady, chyba że przyrostek ma niejednoznaczne znaczenie w domenie aplikacji.
Powiązane reguły
CA1710: Identyfikatory powinny mieć poprawny przyrostek