CA1709: Malá a velká písmena identifikátorů by měla být použita správně

  • Článek
Zboží Hodnota
RuleId CA1709
Kategorie Microsoft.Naming
Změna způsobující chybu Přerušení – při vyvolání u sestavení, oborů názvů, typů, členů a parametrů

Nerušení – při spuštění u obecných parametrů typu

Příčina

Název identifikátoru není správně velká a malá písmena.

- nebo -

Název identifikátoru obsahuje zkratku se dvěma písmeny a druhé písmeno je malými písmeny.

- nebo -

Název identifikátoru obsahuje zkratku tří nebo více velkých písmen.

Popis pravidla

Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). Tato konzistence snižuje křivku učení potřebnou pro nové softwarové knihovny a zvyšuje důvěru zákazníků, že knihovnu vyvinul někdo, kdo má zkušenosti s vývojem spravovaného kódu.

Podle konvence používají názvy parametrů velká písmena a obor názvů, typ a názvy členů používají písmena Pascal. Ve camel-cased name, the first letter is lowercase, and the first letter of any remaining words in the name is uppercase. Příklady velbloudních názvů jsou packetSniffer, ioFilea fatalErrorCode. V názvu Pascalu je první písmeno velké a první písmeno všech zbývajících slov v názvu je velké. Příklady názvů s písmeny Pascal jsou PacketSniffer, IOFilea FatalErrorCode.

Toto pravidlo rozdělí název na slova na základě písmen a zkontroluje všechna slova se dvěma písmeny na seznamu běžných dvoupísmenných slov, například "In" nebo "My". Pokud se shoda nenajde, předpokládá se, že se jedná o zkratku. Kromě toho toto pravidlo předpokládá, že našel zkratku, pokud název obsahuje čtyři velká písmena v řádku nebo tři velká písmena v řádku na konci názvu.

Podle konvence používají dvoupísmenné zkratky všechna velká písmena a zkratky tří nebo více znaků používají písmena Pascal. Následující příklady používají tuto konvenci pojmenování: DB, CR, Cpa a Ecma. Následující příklady porušují konvenci: Io, XML a DoD a pro názvy parametrů, xp a cpl.

Id je speciální případ, který způsobí porušení tohoto pravidla. Id není zkratka, ale zkratka pro identifikaci.

Jak opravit porušení

Změňte název tak, aby se správně zobrazoval velká a malá písmena.

Kdy potlačit upozornění

Toto upozornění je bezpečné potlačit, pokud máte vlastní zásady vytváření názvů nebo pokud identifikátor představuje správný název, například název společnosti nebo technologie.

Do vlastního slovníku pro analýzu kódu můžete také přidat konkrétní termíny, zkratky a zkratky. Termíny zadané ve vlastním slovníku nebudou způsobovat porušení tohoto pravidla. Další informace naleznete v tématu Postupy: Přizpůsobení slovníku analýzy kódu.

CA1708: Identifikátory by se měly lišit více než použitím malých a velkých písmen