CA1711: Identifikátory by neměly mít nesprávnou příponu
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
Kategorie |
Microsoft.Naming |
Narušující změna |
Narušující |
Příčina
Identifikátor nemá správnou příponu.
Popis pravidla
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.
Následující tabulka uvádí vyhrazené přípony a základní typy a rozhraní, ke kterým jsou přidruženy.
Přípona |
Základní typ/rozhraní |
|---|---|
Atribut |
|
Collection |
|
Dictionary |
|
EventArgs |
|
EventHandler |
Delegát obslužné rutiny události |
Výjimka |
|
Oprávnění |
|
Fronta |
|
Zásobník |
|
Stream |
Kromě toho by neměly být použity následující přípony:
Delegovat
Výčet
Impl - místo toho použijte "Core"
Ex nebo podobná přípona k rozlišení od starší verze stejného typu
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.
Jak vyřešit porušení
Odeberte příponu z názvu typu.
Kdy potlačit upozornění
Nepotlačujte upozornění tohoto pravidla, pokud nemá přípona v doméně aplikace jednoznačný význam.
Související pravidla
CA1710: Identifikátory by měly mít správnou příponu