Upozornění na pojmenování
Podporu dodržování konvencí vytváření názvů upozornění .NET Framework Design Guidelines.
V tomto oddíle
Pravidlo |
Description |
---|---|
Toto pravidlo předpokládá, že člen výčtu, který má název obsahující "reserved", není aktuálně používán, ale je zástupným symbolem k přejmenování nebo odstranění v budoucí verzi.Přejmenování nebo odstranění členu je narušující změnou. |
|
Název události začíná řetězcem "Before" nebo "After".Pro pojmenování souvisejících událostí vyvolaných v určitém pořadí je vhodné používat přítomný a minulý čas, který naznačí 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 označuje, že lze zadat více než jednu hodnotu. |
|
Název externě viditelného identifikátoru obsahuje jedno nebo více slov, které nejsou rozpoznány knihovnou pravopisu společnosti Microsoft. |
|
CA1708: Identifikátory by se měly lišit více než použitím malých a velkých písmen |
Identifikátory pro obory názvů, typy, členy a parametry nelze odlišit pouze ve velikosti písmen, protože jazyky cílené na modul CLR (Common Language Runtime) nemusí rozlišovat malá a velká písmena. |
Název externě viditelné rozhraní nezačíná písmeno "I". Název obecného typu parametru na zvnějšku viditelný typ nebo metodu nelze spustit s velkým "T". |
|
Název parametru externě viditelného člena obsahuje název datového typu nebo název externě viditelného člena obsahuje název datového typu daného jazyka. |
|
Dle úmluvy mají pouze některé programovací prvky názvy začínající určitou předponou. |
|
Pouze názvy typů, které rozšiřují určité základní typy nebo které implementují určitá rozhraní nebo typy, které jsou odvozeny z těchto typů by podle úmluvy měly končit určitými vyhrazenými příponami.Další názvy typu by neměly používat tyto vyhrazené přípony. |
|
CA1717: Pouze výčty FlagsAttribute by měly mít názvy v množném čísle |
Konvence pojmenování přikazují, že množný název výčtu označuje, že lze současně zadat více než jednu hodnotu výčtu. |
CA1725: Názvy parametrů by měly odpovídat základní deklaraci |
Konzistentní pojmenování parametrů v hierarchii přetěžování zvyšuje použitelnost přetížení metody.Název parametru, který se v odvozené metodě liší od názvu v základní deklaraci, může způsobit zmatení, zda se jedná o přetíženou metodu základní metody nebo o nové přetížení metody. |
Sdělí význam parametru název parametru a smyslu člen sdělí jméno člena.Byl by to vzácný návrh, pokud by byly stejné.Stejné pojmenování parametru jako jeho názvu členu je neintuitivní a činí knihovnu obtížně použitelnou. |
|
CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně |
Každé slovo řetězce zdroje je rozděleno na tokeny na základě velikosti písmen.Každá kombinace dvou sousedících tokenů je zkontrolována knihovnou kontroly pravopisu společnosti Microsoft.Je-li kombinace rozpoznána, způsobí slovo porušení pravidla. |
Zdrojový řetězec obsahuje jedno nebo více slov, které Knihovna kontroly pravopisu společnosti Microsoft nerozpoznala. |
|
Názvy typů by se neměly shodovat s názvy v oborech názvů definovaných v knihovně tříd rozhraní .NET Framework.Porušení tohoto pravidla může snížit na použitelnost knihovny. |
|
Názvy identifikátorů podle konvence neobsahují znak podtržítko (_).Toto pravidlo kontroluje obory názvů, typy, členy a parametry. |
|
Název soukromého nebo chráněného členu začíná na "Get" a dále se shoduje s názvem veřejné nebo chráněné vlastnosti. "Get" metody a vlastnosti by měly mít názvy, které jasně rozlišit jejich funkce. |
|
Název oboru názvů nebo název typu odpovídá rezervovanému klíčovému slovu programovacího jazyka.Identifikátory pro obory názvů a typů by neměly odpovídat klíčovým slovům, která jsou definována jazyky cílenými na modul CLR (Common Language Runtime). |
|
Název externě viditelného identifikátoru zahrnuje výraz, pro který existuje alternativní, upřednostňovaný výraz.Případně název obsahuje také výraz Flag nebo Flags. |
|
CA1709: Malá a velká písmena identifikátorů by měla být použita správně |
Podle konvence používají názvy parametrů velbloudí pouzdrem a obor názvů, typu a názvy členů Pascal pouzdrem. |
CA1702: Malá a velká písmena složených slov by měla být použita správně |
Název identifikátoru obsahuje více slov a alespoň jedno ze slov se zdá být složené slovo, které není správně formátováno. |
Jména členů výčtu nejsou předponou název typu, protože se očekává, že informace o typu poskytované nástroje pro vývoj. |
|
Podle konvence by měly názvy typů, které rozšiřují některé základní typy nebo určitá rozhraní, nebo typů odvozené z těchto typů, mít příponu, která je přidružená těmto typům nebo rozhraním. |