CA1704: Identifikátory by měly být zadány správně

  • Článek
Zboží Hodnota
RuleId CA1704
Kategorie Microsoft.Naming
Změna způsobující chybu Narušující

Příčina

Název identifikátoru obsahuje jedno nebo více slov, která knihovna kontroly pravopisu společnosti Microsoft nerozpozná. Toto pravidlo nekontroluje konstruktory ani speciální členy, jako jsou get a set property accessors.

Popis pravidla

Toto pravidlo analyzuje identifikátor do tokenů a kontroluje pravopis jednotlivých tokenů. Algoritmus analýzy provádí následující transformace:

  • Velká písmena začínají novým tokenem. Například MyNameIsJoe tokenizuje "My", "Name", "Is", "Joe".

  • U více velkých písmen začíná poslední velké písmeno nový token. Například GUIEditor tokenizuje na "GUI", "Editor".

  • Úvodní a koncové apostrofy jsou odebrány. Například 'sender' tokenizes to "sender".

  • Podtržítka označují konec tokenu a odeberou se. Například Hello_world tokenizuje "Hello", "world".

  • Vložené ampersandy se odeberou. Například pro &mat tokenizuje "formát".

Jazyk

Kontrola pravopisu v současné době kontroluje pouze slovníky jazykové verze v angličtině. Jazykovou verzi projektu můžete změnit v souboru projektu přidáním elementu CodeAnalysisCulture .

Příklad:

<Project ...>
  <PropertyGroup>
    <CodeAnalysisCulture>en-AU</CodeAnalysisCulture>

Důležité

Pokud jazykovou verzi nastavíte na cokoli jiného než anglickou jazykovou verzi, toto pravidlo analýzy kódu se tiše zakáže.

Jak opravit porušení

Pokud chcete opravit porušení tohoto pravidla, opravte pravopis slova nebo ho přidejte do vlastního slovníku.

Přidání slov do vlastního slovníku

Pojmenujte soubor XML vlastního slovníku CustomDictionary.xml. Umístěte slovník do instalačního adresáře nástroje, adresáře projektu nebo do adresáře, který je přidružený k nástroji, pod profil uživatele (%USERPROFILE%\Application Data\...). Informace o tom, jak přidat vlastní slovník do projektu v sadě Visual Studio, najdete v tématu Postupy: Přizpůsobení slovníku analýzy kódu.

  • Přidejte slova, která by neměla způsobit narušení cesty slovníku, slov nebo rozpoznané cesty.

  • Přidejte slova, která by měla způsobit porušení v cestě Dictionary/ Words/Unrecognized.

  • Přidejte slova, která by měla být označena jako zastaralá v rámci cesty Dictionary/Words/Deprecated. Další informace najdete v tématu souvisejícího pravidla CA1726: Použití upřednostňovaných termínů .

  • Do cesty Dictionary/Acronyms/CasingExceptions přidejte výjimky pravidel akronyms/CasingExceptions.

Následuje příklad struktury vlastního souboru slovníku:

<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>

Kdy potlačit upozornění

Potlačit upozornění z tohoto pravidla pouze v případě, že je slovo úmyslně chybně napsané a slovo platí pro omezenou sadu knihovny. Správně napsaná slova snižují křivku učení, která je nutná pro nové softwarové knihovny.

Viz také