CA1709: Identyfikatory powinny być bocznym poprawnie
TypeName |
IdentifiersShouldBeCasedCorrectly |
CheckId |
CA1709 |
Kategoria |
Microsoft.Naming |
Złamanie zmiany |
Przerywanie - gdy wywoływane na zestawy, obszary nazw, typów, członków i parametry. Bez podziału - gdy wywoływane na parametry typu rodzajowego. |
Przyczyna
Nazwa identyfikatora nie jest poprawnie bocznym.
- lub -
Nazwa identyfikatora zawiera skrót dwóch list i drugi listu jest małymi literami.
- lub -
Nazwa identyfikatora zawiera akronimem trzy lub więcej wielkich liter.
Opis reguły
Konwencje nazewnictwa przewidują wspólne wygląd biblioteki docelowej aparatu plików wykonywalnych języka wspólnego.Zmniejsza to krzywej uczenia się, która jest wymagana dla nowych bibliotek oprogramowania i zwiększa zaufanie klientów, że biblioteka została opracowana przez osobę, która ma doświadczenie w rozwijającym się kod zarządzany.
Umownie nazwy parametrów użyj Pascala; nazwy obszaru nazw, typ i Członkowskie użyć Pascal obudowy.Nazwę wielbłąda pierwsza litera jest małymi literami, a pierwszą literę wszelkie pozostałe wyrazy w nazwie jest dużymi literami.Przykłady nazw wielbłąda "packetSniffer", "ioFile" i "fatalErrorCode".W nazwie bocznym Pascal pierwszej litery jest wielkimi literami i pierwszą literę wszelkie pozostałe wyrazy w nazwie jest w wielkich.Przykłady nazw Pascal pisane dużymi literami "PacketSniffer", "IOFile" i "FatalErrorCode".
Ta reguła dzieli nazwę na wyrazy, na podstawie obudowy i sprawdza, czy wszystkie wyrazy dwuliterowy przeciwko listy typowych słów dwóch list, takich jak "W" lub "My".Jeśli nie zostanie znaleziony odpowiednik, wyraz zakłada się akronim.Ponadto w tej reguły zakłada się, że ma znaleźć akronimem, gdy nazwa zawiera cztery wielkie litery w wierszu albo trzy wielkie litery w wierszu na końcu nazwy.
Umownie, dwóch akronimami używać wszystkie wielkie litery, a akronimy trzy lub więcej znaków Pascal obudowy.W następujących przykładach użyto tej konwencji nazewnictwa: "DB", "CR", "Cpa" i "Ecma".Następujące przykłady naruszyć Konwencji: "I¬o" ","XML"i"DoD"oraz nazwy nonparameter,"xp"i"cpl".
'ID' jest specjalne bocznym spowodować naruszenie tej zasady. 'Identyfikator ' nie jest akronimem, ale jest skrótem "Identyfikacja".
Jak naprawić naruszenia
Zmień nazwę tak, że jest poprawnie bocznym.
Kiedy do pomijania ostrzeżenia
Bezpiecznie pominąć to ostrzeżenie, jeśli konwencji nazewnictwa lub identyfikator reprezentuje nazwę odpowiedniego, na przykład, nazwa firmy lub technologii.
Można również dodać specyficznych terminów, skrótów i akronimów, do analizy kodu niestandardowego słownika.Warunki określone w słowniku niestandardowym nie spowodują naruszenie tej zasady.Aby uzyskać więcej informacji zobaczJak: dostosować słownik analizy kodu
Zasady pokrewne
CA1708: Identyfikatory powinny się różnić o więcej niż w przypadku