Pojmenování varování
Podporu dodržování konvencí vytváření názvů upozornění .NET Framework návrhu.
V tomto oddíle
Pravidlo |
Description |
---|---|
Toto pravidlo se předpokládá, že člen výčtu, který má název, který obsahuje "vyhrazené" aktuálně není používán, ale je zástupný symbol přejmenovány nebo odstraněny v budoucí verzi.Přejmenování nebo odstranění členu je změnit rozdělení. |
|
Název události začíná "Před" nebo "Po".Název související události, které jsou aktivována v určitém pořadí, použijte současné nebo minulost označující relativní pozici v pořadí akcí. |
|
Veřejné výčet má atribut System.FlagsAttribute a jeho název nekončí "s".Typy, které jsou označeny FlagsAttribute mají názvy, které jsou v množném čísle, protože atribut znamená, že lze zadat více než jednu hodnotu. |
|
Název externě viditelné identifikátor obsahuje jedno nebo více slov, které nejsou rozpoznávány knihovny kontroly pravopisu Microsoft. |
|
Identifikátory pro obory názvů, typy, členy a parametry nelze liší pouze v případě protože jazyky, které cíl společného jazykového modulu runtime nemusí být malá a velká písmena. |
|
Název viditelného rozhraní nezačíná kapitálu "I".Obecný typ parametru na typ externě viditelné nebo metoda název nezačíná kapitálu "T". |
|
Název parametru externě viditelné člena obsahuje název datového typu nebo název externě viditelné člena obsahuje název jazyka datového typu. |
|
Dle úmluvy mají pouze některé programovací prvky názvy začínající určitou předponou. |
|
Dle úmluvy pouze názvy typů, rozšíření některých základních typů nebo který provádět určité rozhraní nebo typy, které jsou odvozeny z těchto typů by měl končit určité vyhrazené přípony.Další názvy typu není vhodné používat tyto vyhrazené přípony. |
|
CA1717: Pouze výčty FlagsAttribute by měly mít názvy v množném čísle |
Konvence diktovat množném čísle název výčtu označuje, že současně lze zadat více než jednu hodnotu výčtu. |
CA1725: Názvy parametrů by měly odpovídat základní prohlášení |
Konzistentní názvů parametrů přepsání hierarchie zvyšuje použitelnost přepíše metodu.Název parametru v Odvozená metoda, která se liší od názvu v základní prohlášení může způsobit nejasnosti, zda je metoda lokálními základní metody nebo nové přetížení metody. |
Název parametru sdělit význam parametru a název člena sdělit smyslu člen.Vzácné návrhu by v případě, že byly stejné.Pojmenování parametr stejné jako jeho název členu unintuitive, obtížné použít knihovnu. |
|
CA1701: Uváděna velkými složená slova řetězec zdroje by měly být písmeny správně |
Každé slovo v řetězci zdroje je rozděleno do tokeny, které jsou založeny na šachty.Knihovny Microsoft pravopisu kontroluje souvislé kombinace dvou token.Pokud rozpoznána, vznikne slovo porušení pravidla. |
Zdrojový řetězec obsahuje jedno nebo více slov, které nejsou rozpoznávány knihovny kontroly pravopisu Microsoft. |
|
Zadejte jména by neodpovídají názvy oborů názvů, které jsou definovány v .NET Framework knihovna tříd.Porušení tohoto pravidla lze omezit použitelnost knihovny. |
|
Podle úmluvy názvy identifikátorů nesmí obsahovat znak podtržení (_).Toto pravidlo zkontroluje obory názvů, typy, členy a parametry. |
|
Název člena veřejné nebo chráněné začíná "Get" a jinak odpovídá názvu vlastnosti veřejné nebo chráněné. "Vlastnosti a metody GET", by měly mít názvy, které zřetelně rozlišit jejich funkce. |
|
Název typu nebo oboru názvů názvu odpovídá rezervované klíčové slovo v programovacím jazyce.Identifikátory pro obory názvů a typů by neodpovídají klíčová slova, která jsou definovány jazyky, které cíl společného jazykového modulu runtime. |
|
Název identifikátoru externě viditelné zahrnuje období, pro které existuje alternativní, upřednostňovaný funkční období.Název také zahrnuje pojem "Příznak" nebo "Příznaky". |
|
CA1709: Uváděna velkými identifikátory by měla být písmeny správně |
Úmluva, používají názvy parametrů camel šachty a oboru názvů, typu a názvy členů Pascal pouzdře. |
CA1702: Uváděna velkými složená slova by měla být písmeny správně |
Název identifikátoru obsahuje více slov a alespoň jedno ze slov se zdá být uváděna velkými nejsou písmeny správně složené slovo. |
Názvy členů výčtu není předponou s názvem typ, protože očekává typ informací, poskytuje nástroje pro vývoj. |
|
Podle konvence názvů typů, rozšíření některých základních typů nebo který provádět určité rozhraní nebo typy odvozené z těchto typů mají příponu, která je přidružena základní typ nebo rozhraní. |