CA1711: Identifikátory by neměly mít nesprávnou příponu

  • Článek
Vlastnost Hodnota
ID pravidla CA1711
Název Identifikátory by neměly mít nesprávnou příponu
Kategorie Pojmenování
Oprava způsobující chybu nebo chybu způsobující chybu Narušující
Povoleno ve výchozím nastavení v .NET 8 No

Příčina

Identifikátor nemá správnou příponu.

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné identifikátory, ale dá se konfigurovat.

Popis pravidla

Pouze názvy typů, které rozšiřují určité základní typy nebo které implementují určitá rozhraní, nebo typů odvozených 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.

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 System.Attribute
Kolekce System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Slovník System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
Eventargs System.EventArgs
Eventhandler Delegát obslužné rutiny události
Výjimka System.Exception
Oprávnění System.Security.IPermission
Fronta System.Collections.Queue
Zásobník System.Collections.Stack
Stream System.IO.Stream

Kromě toho by se neměly používat následující přípony:

  • Delegate
  • Enum
  • Impl (místo toho použijte Core )
  • Ex nebo podobnou příponu k odlišení od starší verze stejného typu
  • Flag nebo Flags pro typy výčtu

Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). To snižuje křivku učení, která je nutná pro nové softwarové knihovny, a zvyšuje důvěru zákazníků, že knihovna byla vyvinuta někým, kdo má zkušenosti s vývojem spravovaného kódu. Další informace naleznete v tématu Pokyny pro pojmenování: třídy, struktury a rozhraní.

Jak opravit porušení

Odeberte příponu z názvu typu.

Kdy potlačit upozornění

Nepotlačujte upozornění tohoto pravidla, pokud přípona nemá v doméně aplikace jednoznačný význam.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

#pragma warning disable CA1711
// The code that's violating the rule is on this line.
#pragma warning restore CA1711

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

[*.{cs,vb}]
dotnet_diagnostic.CA1711.severity = none

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následujících možností můžete nakonfigurovat, pro které části základu kódu se má toto pravidlo spouštět.

Tyto možnosti můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (pojmenování), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Povolit přípony

Můžete nakonfigurovat seznam povolených přípon s každou příponou oddělenou znakem svislé roury (|). Pokud chcete například určit, že by se pravidlo nemělo spouštět proti příponám Flag a Flags, přidejte do souboru .editorconfig v projektu následující dvojici klíč-hodnota:

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

Viz také