Nazewnictwo — Ostrzeżenia
Nazewnictwa ostrzeżenia wsparcie przestrzeganie konwencje nazewnictwa .NET Framework wytyczne dotyczące projektowania.
W tej sekcji
Reguła |
Opis |
---|---|
CA1700: Nie należy nadawać wartościom enum oznaczenia „Reserved" |
Ta reguła zakłada, że element członkowski wyliczenia, którego nazwa zawiera "zastrzeżone", nie jest obecnie używany, ale jest symbolem zastępczym do zmiany nazwy lub usunięcia w przyszłej wersji.Zmiana nazwy lub usuwanie elementu członkowskiego jest zmianą kluczową. |
CA1713 Zdarzenia nie powinny posiadać prefiksów 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: Typy wyliczeniowe flag powinny mieć nazwy w liczbie mnogiej |
Wyliczenie publiczne ma atrybut System.FlagsAttribute i jego nazwy nie kończy się na "s".Typy, które są oznaczone FlagsAttribute mają nazwy, które są liczby mnogiej, ponieważ atrybut wskazuje, że można określić więcej niż jedną wartość. |
Nazwa widocznego z zewnątrz identyfikatora zawiera jeden lub więcej wyrazów, które nie są rozpoznany przez bibliotekę sprawdzania pisowni Microsoft. |
|
CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter |
Identyfikatory przestrzeni nazw, typów, elementów członkowskich i parametry nie mogą się różnić jedynie wielkością liter, ponieważ nie jest wymagane, aby języki docelowe środowiska wykonawczego języka wspólnego rozróżniały wielkość liter. |
Nazwa interfejsu widocznego zewnętrznie nie rozpoczyna się od kapitału "I". Nazwa parametru typu rodzajowego na zewnątrz typ lub metoda nie rozpoczyna się od kapitału "T". |
|
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. |
|
Przez konwencję, tylko niektóre elementy mają nazwy, które rozpoczynają się od określonego prefiksu. |
|
Przez konwencję, nazwy typów, które rozszerzają pewne typy podstawowe lub implementują pewne interfejsy lub typy pochodzące z tych typów, powinny się kończyć przez określony, zarezerwowany sufix.Inne nazwy typów nie powinny używać tych zarezerwowanych sufiksów. |
|
CA1717: Tylko typy wyliczeniowe FlagsAttribute powinny mieć nazwy w liczbie mnogiej |
Konwencje nazewnictwa dyktują, że nazwa w liczbie mnogiej dla wyliczenia wskazuje, że w tym samym czasie można określić więcej niż jedną wartość wyliczenia. |
CA1725: Nazwy parametrów powinny pasować do podstawowej deklaracji |
Spójne nazywanie parametrów w zastąpieniu hierarchii zwiększa użyteczność zastąpienia metody.Nazwę parametru w metodzie pochodnej, która różni się od nazwy podstawowej deklaracji, może powodować dezorientację czy metoda jest zastąpieniem metody podstawowej lub nowym przeciążeniem metody. |
CA1719: Nazwy parametrów nie powinny odpowiadać nazwom elementów członkowskich |
Nazwa parametru powinny przekazywać znaczenie parametru i nazwa elementu członkowskiego powinny przekazywać znaczenie elementu członkowskiego.Rzadko w projekcie są one takie same.Nazywanie parametru tak samo jak nazwa jego elementu członkowskiego jest nieintuicyjne i utrudnia używanie biblioteki. |
CA1701: Wyrazy złożone ciągu zasobu należy zapisywać z uwzględnieniem wielkości liter |
Każde słowo w ciągu zasobu jest podzielone na tokeny, które są oparte na wielkości liter.Każda ciągła kombinacja dwóch tokenów jest sprawdzana przez bibliotekę sprawdzania pisowni firmy Microsoft.Jeżeli zostanie rozpoznane, słowo powoduje naruszenie reguły. |
Ciąg zasobu zawiera jeden lub więcej wyrazów, które nie są rozpoznane przez bibliotekę sprawdzania pisowni Microsoft. |
|
Nazwy typów powinny nie odpowiadać nazwom przestrzeni nazw, które są zdefiniowane w bibliotece klas .NET Framework.Naruszenie tej zasady może zmniejszyć użyteczność biblioteki. |
|
Przez konwencję, identyfikatory nazw nie zawierają znaku podkreślenia (_).Ta reguła sprawdza przestrzenie nazw, typy, elementy członkowskie i parametry. |
|
CA1721: Nazwy właściwości nie powinny odpowiadać metodom Get |
Nazwa publicznego lub chronionego elementu członkowskiego zaczyna się od "Get" i odpowiada nazwie właściwości publicznej lub chronionej. Właściwości i metody "Get" powinien mieć nazwy, które wyraźnie odróżnić ich funkcji. |
CA1716: Identyfikatory nie powinny odpowiadać słowom kluczowym |
Przestrzeń nazw lub nazwa typu odpowiada zastrzeżonym słowom kluczowym w języku programowania.Identyfikatory przestrzeni nazw i typów nie powinny być zgodna ze słowami kluczowymi, które są definiowane przez języki dla CLR. |
Nazwa widocznego z zewnątrz identyfikatora zawiera termin, dla którego istnieje alternatywny, preferowany termin.Alternatywnie, nazwa zawiera określenie "Flag" lub "Flags". |
|
CA1709: Identyfikatory powinny być zapisywane z uwzględnieniem wielkości liter |
Umownie, nazwy parametrów użyć wielbłądów typ obudowy i obszar nazw, oraz nazwy składników języka Pascal obudowy. |
CA1702: Wyrazy złożone należy zapisywać z uwzględnieniem wielkości liter |
Nazwa identyfikatora zawiera wiele wyrazów i co najmniej jeden z wyrazów wydaje się być złożonym wyrazem, w którym wielkość liter nie jest poprawna. |
Nazwiska członków wyliczenie nie jest poprzedzona prefiksem Nazwa typu, ponieważ oczekuje się udzielane przez narzędzia programistyczne, informacje o typie. |
|
Według konwencji, nazwy typów, które rozszerzają niektóre typy podstawowe lub implementują niektóre interfejsy, lub typy pochodzące od tych typów, mają przyrostek, który jest skojarzony z typem podstawowym lub interfejsem. |