Reguły nazewnictwa
W tej sekcji
Reguła | Opis |
---|---|
CA1700: Nie nadawaj wartościom wyliczeniowym nazwy „Reserved” | Ta reguła zakłada, że element członkowski wyliczenia o nazwie, która zawiera „reserved”, nie jest obecnie używany, ale jest symbolem zastępczym do zmiany nazwy lub usunięcia w przyszłej wersji. Zmiana nazwy lub usuwanie członka jest zmianą przerywającą. |
CA1707: Identyfikatory nie powinny zawierać znaków podkreślenia | Przez konwencję identyfikatory nazw nie zawierają znaku podkreślenia (_). Ta reguła sprawdza przestrzenie nazw, typy, elementy członkowskie i parametry. |
CA1708: Identyfikatory powinny różnić się nie tylko wielkością liter | Identyfikatory przestrzeni nazw, typów, elementów członkowskich i parametry nie mogą się różnić jedynie wielkością liter, ponieważ języki dla środowiska uruchomieniowego języka wspólnego nie muszą rozróżniać wielkości liter. |
CA1710: Identyfikatory powinny mieć poprawny sufiks | Zgodnie z konwencją nazwy typów, które rozszerzają niektóre typy podstawowe lub implementują niektóre interfejsy lub typy pochodzące z tych typów, mają sufiks skojarzony z typem podstawowym lub interfejsem. |
CA1711: Identyfikatory nie powinny mieć nieprawidłowych sufiksów | Według konwencji nazwy typów, które rozszerzają pewne typy podstawowe lub implementują dane interfejsy lub typy pochodzące z tych typów, powinny kończyć się określonym zarezerwowanym sufiksem. Inne nazwy typów nie powinny używać tych zarezerwowanych sufiksów. |
CA1712: Nie dodawaj prefiksu z nazwą typu do wartości wyliczeniowych | Nazwy składowych wyliczenia nie są poprzedzone nazwą typu, ponieważ informacje o typie powinny być udostępniane przez narzędzia programistyczne. |
CA1713: Zdarzenia nie powinny mieć prefiksu „before” ani „after” | Nazwa zdarzenia rozpoczyna się od „Before” lub „After”. 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. |
CA1714: Wyliczenia z atrybutem Flags powinny mieć nazwy w liczbie mnogiej | Publiczne wyliczenie ma atrybut System.FlagsAttribute, a jego nazwa nie kończy się na "s". Typy oznaczone atrybutem FlagsAttribute mają nazwy w liczbie mnogiej, ponieważ atrybut wskazuje, że można określić więcej niż jedną wartość. |
CA1715: Identyfikatory powinny mieć poprawny prefiks | Nazwa interfejsu widocznego zewnętrznie nie zaczyna się od litery "I". Nazwa parametru typu ogólnego w typie widocznym zewnętrznie lub metodzie nie zaczyna się od litery "T". |
CA1716: Identyfikatory nie powinny być zgodne ze słowami kluczowymi | Przestrzeń nazw lub nazwa typu odpowiada zastrzeżonym słowom kluczowym w języku programowania. Identyfikatory przestrzeni nazw i typów nie powinny być zgodne ze słowami kluczowymi, które są definiowane przez języki dla środowiska uruchomieniowego języka wspólnego. |
CA1717: Tylko wyliczenia z atrybutem Flags powinny mieć nazwy w liczbie mnogiej | Zgodnie z konwencjami nazewnictwa, nazwa w liczbie mnogiej dla wyliczenia wskazuje, że w tym samym czasie można określić więcej niż jedną wartość wyliczenia. |
CA1720: Identyfikatory nie powinny zawierać nazw typów | Nazwa parametru w widocznym na zewnątrz elemencie członkowskim zawiera nazwę typu danych lub nazwa widocznego na zewnątrz elementu członkowskiego zawiera specyficzną dla języka nazwę typu danych. |
CA1721: Nazwy właściwości nie powinny być takie same jak nazwy metod Get | Nazwa publicznego lub chronionego elementu członkowskiego zaczyna się od „Get” i odpowiada nazwie właściwości publicznej lub chronionej. Metody „Get” i właściwości powinny mieć nazwy, które wyraźnie odróżniają ich funkcje. |
CA1724: Nazwy typów nie powinny być takie same jak nazwy przestrzeni nazw | Nazwy typów nie powinny być zgodne z nazwami przestrzeni nazw platformy .NET. Naruszenie tej reguły może zmniejszyć użyteczność biblioteki. |
CA1725: Nazwy parametrów powinny być zgodne z deklaracją podstawową | Spójne nazywanie parametrów w zastąpieniu hierarchii zwiększa użyteczność zastąpienia metody. Jeśli nazwa parametru w metodzie pochodnej różni się od nazwy podstawowej deklaracji, może nie być jasne, czy metoda jest zastąpieniem metody podstawowej, czy też nowym przeciążeniem metody. |
CA1727: Użyj pascalCase dla nazwanych symboli zastępczych | Użyj pascalCase dla nazwanych symboli zastępczych w szablonie komunikatu rejestrowania. |
Współpracuj z nami w serwisie GitHub
Źródło tej zawartości można znaleźć w witrynie GitHub, gdzie można również tworzyć i przeglądać problemy i żądania ściągnięcia. Więcej informacji znajdziesz w naszym przewodniku dla współtwórców.