CA1704: Identifikátory by měly být zadány správně
Název_typu |
IdentifiersShouldBeSpelledCorrectly |
CheckId |
CA1704 |
Kategorie |
Microsoft.Naming |
Změnit rozdělení |
Rozdělení |
Příčina
Název identifikátoru obsahuje jedno nebo více slov, které nejsou rozpoznávány knihovny kontroly pravopisu Microsoft.Toto pravidlo není konstruktory a s názvem zvláštní členů, jako například get a nastavit přístupové objekty vlastnosti.
Popis pravidla
Toto pravidlo analyzuje identifikátor do tokenů a kontroly pravopisu každý token.Analýzy algoritmus provede následující transformace:
Velká písmena spustit nový token.Například MyNameIsJoe tokenizes "Moje", "Název", "Je", "Joe".
Poslední velké písmeno pro více velká písmena, spustí nový token.Například GUIEditor, tokenizes na "GUI", "Editor".
Úvodní a koncové apostrofy odebrány.Např.: "odesílatel" tokenizes "odesílatel".
Podtržítka označuje konec token a jsou odstraněny.Například Hello_world tokenizes na "Ahoj", "world".
Tyto vložené znaky budou odebrány.Například pro & tokenizes mat "formátování".
Ve výchozím nastavení používá angličtinu (en) verze kontroly pravopisu.Další jazykové slovníky jsou aktuálně k dispozici.
Jak opravit porušení
Oprava porušení tohoto pravidla pravopisu slova nebo přidat slovo do vlastního slovníku s názvem CustomDictionary.xml.Umístěte slovníku v instalačním adresáři nástroj adresáře projektu nebo v adresáři, který je spojen s nástrojem v rámci profilu uživatele (%USERPROFILE%\Application... Data\).Informace o způsobu přidání vlastního slovníku projektu v Visual Studio, vizPostupy: Přizpůsobení slovníku Analýzy kódu
Přidáte slova, která by neměl způsobit narušení slovník, slova nebo Recognized cestě.
Přidáte slova, která by způsobit narušení v cestě slovník, slova nebo Nerozpoznán.
Přidáte slova, která by měla být označena jako zastaralá v cestě slovník, slova nebo Deprecated.Naleznete v tématu Příbuzná pravidlo CA1726: Použijte upřednostňované výrazyDalší informace.
Přidáte výjimky akronym pouzdře pravidel cesty slovník, akronymy/CasingExceptions.
Následuje příklad struktury souboru vlastního 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>
Při potlačení upozornění
Potlačit varování od tohoto pravidla, pouze pokud je úmyslně chybně napsané slovo a slovo se vztahuje na omezený počet knihovny.Správně hláskovaným slova zmenšíte křivku učení, požadované pro nové knihovny softwaru.
Souvisejících pravidel
CA2204: Literály by měly být zadány správně
CA1703: Řetězce prostředků by měly být zadány správně
CA1709: Malá a velká písmena identifikátorů by měla být použita správně
CA1708: Identifikátory by se měly lišit více než použitím malých a velkých písmen
CA1707: Identifikátory by neměly obsahovat podtržítka
CA1726: Použijte upřednostňované výrazy