CA1709: Identyfikatory powinny być zapisywane z uwzględnieniem wielkości liter

Pozycja	Wartość
Ruleid	CA1709
Kategoria	Microsoft.Naming
Zmiana powodująca niezgodność	Niezgodność — w przypadku wywoływanych zestawów, przestrzeni nazw, typów, elementów członkowskich i parametrów. Bez przerywania — w przypadku uruchomienia na parametrach typu ogólnego.

Przyczyna

Nazwa identyfikatora nie jest prawidłowa.

- lub -

Nazwa identyfikatora zawiera dwuliterowy akronim, a druga litera jest małą literą.

- lub -

Nazwa identyfikatora zawiera akronim trzech lub więcej wielkich liter.

Opis reguły

Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego języka wspólnego. Ta spójność zmniejsza 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.

Zgodnie z konwencją nazwy parametrów używają wielkości liter wielbłąda, przestrzeni nazw, typów i składowych używają wielkości liter Pascal. W nazwie wielbłądowej pierwsza litera jest małą literą, a pierwsza litera pozostałych wyrazów w nazwie jest wielką literą. Przykłady nazw wielbłądów to packetSniffer, ioFilei fatalErrorCode. W nazwie pascala, pierwsza litera jest wielką literą, a pierwsza litera pozostałych wyrazów w nazwie jest wielką literą. Przykłady nazw z literami Pascal to PacketSniffer, IOFilei FatalErrorCode.

Ta reguła dzieli nazwę na wyrazy na podstawie wielkości liter i sprawdza wszystkie dwuliterowe wyrazy na liście typowych dwuliterowych słów, takich jak "In" lub "My". Jeśli dopasowanie nie zostanie znalezione, przyjmuje się, że słowo jest akronimem. Ponadto ta reguła zakłada, że znalazła akronim, gdy nazwa zawiera cztery wielkie litery w wierszu lub trzy wielkie litery w wierszu na końcu nazwy.

Zgodnie z konwencją skróty dwuliterowe używają wszystkich wielkich liter, a akronimy trzech lub więcej znaków używają liter Pascal. W poniższych przykładach użyto tej konwencji nazewnictwa: "DB", "CR", "Cpa" i "Ecma". Poniższe przykłady naruszają konwencję: "Io", "XML" i "DoD" oraz dla nazw innych niż parametrów, "xp" i "cpl".

Element "ID" jest specjalnie przypadkowy, aby spowodować naruszenie tej reguły. "Id" nie jest akronimem, ale jest skrótem do "identyfikacji".

Jak naprawić naruszenia

Zmień nazwę tak, aby była poprawnie wpisana.

Kiedy pomijać ostrzeżenia

Można bezpiecznie pominąć to ostrzeżenie, jeśli masz własne konwencje nazewnictwa lub jeśli identyfikator reprezentuje właściwą nazwę, na przykład nazwę firmy lub technologii.

Możesz również dodać określone terminy, skróty i akronimy do słownika niestandardowego analizy kodu. Terminy określone w słowniku niestandardowym nie spowodują naruszenia tej reguły. Aby uzyskać więcej informacji, zobacz How to: Customize the Code Analysis Dictionary (Instrukcje: dostosowywanie słownika analizy kodu).

Powiązane reguły

CA1708: Identyfikatory powinny różnić się nie tylko wielkością liter