CA1704: Identyfikatory powinny być pisane poprawnie

Artykuł
02/27/2013

TypeName	IdentifiersShouldBeSpelledCorrectly
CheckId	CA1704
Kategoria	Microsoft.Naming
Złamanie zmiany	Złamanie

Przyczyna

Nazwa identyfikatora zawiera jeden lub więcej wyrazów, które nie są rozpoznawane przez bibliotekę sprawdzania pisowni Microsoft.Ta reguła nie Sprawdź konstruktory lub członków o nazwie specjalne, takie jak get i set Akcesory właściwości.

Opis reguły

Ta reguła analizuje identyfikator w tokenach i sprawdza pisownię każdy token.Algorytm parsowania wykonuje przekształcenia następujące:

Wielkie litery uruchomić nowy token.Na przykład MyNameIsJoe tokenizes "Mój", "Nazwa", "Jest", "Joe".
Dla wielu wielkich liter ostatni wielką literą uruchamia nowy token.Na przykład GUIEditor, tokenizes się do "GUI", "Editor".
Początkowe i końcowe apostrofy są usuwane.Na przykład "nadawca" tokenizes do "nadawca".
Podkreślenia oznaczają koniec tokenu i są usuwane.Na przykład, Hello_world tokenizes na "Hello", "world".
Osadzone takie znaki są usuwane.Na przykład dla & mat tokenizes do "format".

Domyślnie używany jest wersja angielskojęzyczna (en) moduł sprawdzania pisowni.Inne słowniki językowe są obecnie dostępne.

Jak naprawić naruszenia

Aby naprawić naruszenie tej zasady, poprawić pisownię wyrazu, lub dodać wyraz do słownika niestandardowego, o nazwie CustomDictionary.xml.Słownik należy umieścić w katalogu instalacyjnym narzędzia katalogu projektu lub w katalogu, który jest skojarzony z narzędziem w profilu użytkownika (%USERPROFILE%\Application... Data\).Aby dowiedzieć się, jak dodać do słownika do projektu w Visual Studio, zobaczJak: dostosować słownik analizy kodu

Dodawać słowa, które nie powinny powodować naruszenie w ścieżce uznanych-słownik/słowa.
Dodawać słowa, które powinny spowodować naruszenie w ścieżce nierozpoznany-słownik/słowa.
Dodać wyrazy, które powinny być flagowane jako przestarzałe w ścieżce wyrazy-słownik/wycofane.Zobacz temat powiązana reguła CA1726: Warunki stosowania preferowaneAby uzyskać więcej informacji.
Dodać wyjątki do reguł obudowa skrót do ścieżki CasingExceptions-słownik/akronimy.

Poniżej przedstawiono przykładową strukturę pliku słownika użytkownika.

   <Dictionary>
      <Words>
         <Unrecognized>
            <Word>cb</Word>
         </Unrecognized>
         <Recognized>
            <Word>stylesheet</Word>
            <Word>GotDotNet</Word>
         </Recognized>
         <Deprecated>
            <Term PreferredAlternate="EnterpriseServices">ComPlus</Term>
         </Deprecated>
      </Words>
      <Acronyms>
         <CasingExceptions>
            <Acronym>CJK</Acronym>
            <Acronym>Pi</Acronym>
         </CasingExceptions>
      </Acronyms>
   </Dictionary>

Kiedy do pomijania ostrzeżenia

Pomija ostrzeżenia od tej zasady tylko, jeśli wyraz jest celowo błędnie i program word stosuje się do ograniczonego zestawu biblioteki.Poprawnie wyrazy pisane zmniejszenie rozmiarów krzywej uczenia wymagany dla nowych bibliotek oprogramowania.