CA1709: Malá a velká písmena identifikátorů by měla být použita správně
TypeName |
IdentifiersShouldBeCasedCorrectly |
CheckId |
CA1709 |
Kategorie |
Microsoft.Naming |
Narušující změna |
Nejnovější - při sestavení, obory názvů, typů, členy a parametry. Bez konce - při vyvolání na parametry obecných typů. |
Příčina
Název identifikátoru není správně notaci.
-nebo-
Název identifikátoru obsahuje dvoupísmennou zkratku a druhé písmeno je malá.
-nebo-
Název identifikátoru obsahuje zkratka tří nebo více velkých písmen.
Popis pravidla
Jmenné konvence poskytují společný vzhled knihovnám, které pracují s modulem CLR (Common Language Runtime).To snižuje křivku učení, která je vyžadována pro naučení nových softwarových knihoven a zvyšuje důvěru zákazníků, že knihovna byla vyvinuta osobou, která má odborné znalosti s vývojem spravovaného kódu.
Podle konvence názvů parametrů používá camelCase; Použití oboru názvů, typu a jména člena Pascal pouzdrem.V názvu používají formát je první písmeno malé a první písmeno všechny zbývající slova v názvu je velkými písmeny.Příklady používají formát názvů jsou "packetSniffer", "ioFile" a "fatalErrorCode".V názvu Pascal notaci první písmena jsou velká a první písmeno všechny zbývající slova v názvu je velkými písmeny.Příklady názvů notaci Pascal: "PacketSniffer", "IOFile" a "FatalErrorCode".
Toto pravidlo rozdělí slova na pouzdře základě názvu a zkontroluje všechny dvou písmen slova proti seznam běžných dvou písmen slova, například "V" nebo "My".Pokud není nalezena shoda, je slovo považován za zkratku.Toto pravidlo navíc předpokládá, že našel zkratku, pokud název obsahuje buď čtyři velká písmena za sebou, nebo tři velká písmena za sebou na konci názvu.
Podle konvence používají dvoupísmenné zkratky písmena a zkratky tři nebo více znaků Pascal pouzdrem.Následující příklady používají tuto konvenci: "DB", "CR", "Cpa" a "Ecma".Příklady porušení úmluvy: "Io", "XML" a "DoD" a v názvu nonparameter, "xp" a "cpl".
'ID' je zvláštní notaci způsobit porušení tohoto pravidla. 'Id' není zkratka, ale je zkratka pro "Identifikace".
Jak vyřešit porušení
Změňte název tak, aby odpovídal formátu.
Kdy potlačit upozornění
Je bezpečné potlačit toto upozornění, pokud máte vlastní konvence, nebo pokud identifikátor představuje vhodný název, například název společnosti nebo technologie.
Můžete také přidat konkrétní termíny, zkratky a akronymy, do vlastního slovníku analýzu kódu.Podmínkami uvedenými ve vlastním slovníku nesmí způsobit porušení tohoto pravidla.Další informace naleznete v tématu Postupy: Přizpůsobení slovníku Analýzy kódu
Související pravidla
CA1708: Identifikátory by se měly lišit více než použitím malých a velkých písmen