CA1709: Identyfikatory powinny być zapisywane z uwzględnieniem wielkości liter
TypeName |
IdentifiersShouldBeCasedCorrectly |
CheckId |
CA1709 |
Kategoria |
Microsoft.Naming |
Zmiana kluczowa |
Przerywanie - gdy wywoływane na zestawy, obszary nazw, typów, członków i parametry. Twarda - gdy zwolniony na parametry typu rodzajowego. |
Przyczyna
Nazwa identyfikatora nie jest poprawnie obudowane.
- lub -
Nazwa identyfikatora zawiera skrót dwuliterowy i drugi list jest małymi literami.
- lub -
Nazwa identyfikatora zawiera skrót trzy lub więcej wielkich liter.
Opis reguły
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.
Umownie nazwy parametrów użyj wielbłądów obudowy; Użyj nazwy obszaru nazw, typów i Państwa Pascal obudowy.W nazwie "wielbłąda" pierwszej litery są małe, a pierwszą literę wszelkie pozostałe wyrazy w nazwie jest wielkimi literami.Przykłady nazw wielbłąda są "packetSniffer", "ioFile" i "fatalErrorCode".W nazwie obudowane Pascal pierwszej litery jest wielkie i pierwszą literę wszelkie pozostałe wyrazy w nazwie jest wielkimi literami.Przykłady nazw obudowane Pascal są "PacketSniffer", "IOFile" i "FatalErrorCode".
Ta reguła rozdziela nazwę na wyrazy oparte na obudowie i sprawdza, czy wszystkie wyrazy dwuliterowy z listą typowych słów dwuliterowy, takich jak "W" lub "My".Jeśli nie znaleziono, wyraz zakłada się skrót.Ponadto ta reguła zakłada, że uznał skrót, gdy nazwa zawiera cztery litery z rzędu albo trzy wielkie litery w wiersz na końcu nazwy.
Umownie, akronimy dwuliterowy używać wielkimi literami, a akronimy trzy lub więcej znaków języka Pascal obudowy.W poniższych przykładach użyto tej konwencji nazewnictwa: "DB", "CR", "Cpa" i "Ecma".Poniższe przykłady narusza konwencji: "I¬o" ","XML"i"DoD"i nazwy nonparameter,"xp"i"Panel sterowania".
'ID' jest specjalne obudowane spowodować naruszenie tej zasady. 'Id' nie jest skrótem, ale jest skrótem "Identyfikacja".
Jak naprawić naruszenia
Zmień nazwę, tak aby była poprawnie napisana z użyciem wielkich i małych liter.
Kiedy pominąć ostrzeżenia
Jest to bezpieczne pominąć to ostrzeżenie, jeśli masz konwencji nazewnictwa, czy identyfikator reprezentuje właściwej nazwy, na przykład nazwę firmy lub technologii.
Można również dodać określone warunki, skrótów i akronimów który do analizy kodu niestandardowego słownika.Warunki określone w słowniku niestandardowym nie spowodują naruszenie tej zasady.Aby uzyskać więcej informacji, zobacz Porady: dostosowywanie słownika analizy kodu.
Powiązane reguły
CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter