Pravidla pojmenování

  • Článek

Pravidla pojmenování podporují dodržování zásad vytváření názvů v pokynech k návrhu .NET.

V této části

Pravidlo Description
CA1700: Nepojmenovávejte výčty hodnot 'Reserved' Toto pravidlo předpokládá, že člen výčtu, který má název obsahující výraz „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ěna.
CA1707: Identifikátory by neměly obsahovat podtržítka Názvy identifikátorů podle konvence neobsahují znak podtržítka (_). Toto pravidlo kontroluje obory názvů, typy, členy a parametry.
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.
CA1710: Identifikátory by měly mít správnou příponu Podle konvence mají názvy typů, které rozšiřují určité základní typy nebo implementují určitá rozhraní, nebo typy odvozené z těchto typů příponu, která je přidružena k základnímu typu nebo rozhraní.
CA1711: Identifikátory by neměly mít nesprávnou příponu 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 konvence měly končit určitými vyhrazenými příponami. Jiné názvy typů by neměly používat tyto vyhrazené přípony.
CA1712: Nezačínejte hodnoty výčtu názvem typu Názvy členů výčtu nemají předponu s názvem typu, protože informace o typu by měly být poskytovány vývojovými nástroji.
CA1713: Události by neměly mít předponu před nebo po 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í.
CA1714: Výčty příznaků by neměly mít názvy v množném čísle Veřejný výčet má atribut System.FlagsAttribute a jeho název nekončí na "s". Typy označené příznakem FlagsAttribute mají názvy, které jsou v množném čísle, protože atribut označuje, že lze zadat více než jednu hodnotu.
CA1715: Identifikátory by měly mít správnou předponu Název externě viditelného rozhraní nezačíná velkým písmenem "I". Název parametru obecného typu u externě viditelného typu nebo metody nezačíná velkým "T".
CA1716: Identifikátory by se neměly shodovat s klíčovými slovy Název oboru názvů nebo název typu odpovídá vyhrazené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).
CA1717: Pouze výčty FlagsAttribute by měly mít názvy v množném čísle Konvence pojmenování přikazují, aby název výčtu v množném čísle vyjadřoval, že lze současně zadat více než jednu hodnotu výčtu.
CA1720: Identifikátory by neměly obsahovat názvy typů Název parametru v externě viditelném členu obsahuje název datového typu nebo název externě viditelného členu obsahuje název datového typu specifický podle jazyka.
CA1721: Názvy vlastností by se neměly shodovat s metodami Get 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. Metody „Get“ a vlastnosti by měly mít názvy, které zřetelně rozliší jejich funkce.
CA1724: Názvy typů by se neměly shodovat s obory názvů Názvy typů by se neměly shodovat s názvy oborů názvů .NET. Porušení tohoto pravidla může snížit použitelnost knihovny.
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 u metody jedná o přepis základní metody, nebo o nové přetížení metody.
CA1727: Pro pojmenované zástupné symboly použijte PascalCase Pro pojmenované zástupné symboly v šabloně zprávy protokolování použijte PascalCase.