CA1716: Identifikátory by neměly odpovídat klíčovým slovům

  • Článek
Vlastnost Hodnota
ID pravidla CA1716
Název Identifikátory by se neměly shodovat s klíčovými slovy
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

Název oboru názvů, typu nebo virtuálního člena nebo člena rozhraní odpovídá vyhrazenému klíčovému slovu v programovacím jazyce.

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné obory názvů, typy a členy, ale můžete nakonfigurovat typy viditelnosti a symbolů.

Popis pravidla

Identifikátory pro obory názvů, typy a virtuální členy a členy rozhraní by neměly odpovídat klíčovým slovům definovaným jazyky, které cílí na modul CLR (Common Language Runtime). V závislosti na používaném jazyce a klíčovém slovu můžou chyby kompilátoru a nejednoznačnosti ztížit použití knihovny.

Toto pravidlo kontroluje klíčová slova v následujících jazycích:

  • Visual Basic
  • C#
  • C++/CLI

Porovnání nerozlišující malá a velká písmena se používá pro klíčová slova jazyka Visual Basic a porovnání s rozlišováním velkých a malých písmen se používá pro ostatní jazyky.

Jak opravit porušení

Vyberte název, který se nezobrazuje v seznamu klíčových slov.

Kdy potlačit upozornění

Upozornění z tohoto pravidla můžete potlačit, pokud jste si jisti, že identifikátor nezaměňuje uživatele rozhraní API a že knihovna je použitelná ve všech dostupných jazycích v .NET.

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 CA1716
// The code that's violating the rule is on this line.
#pragma warning restore CA1716

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.CA1716.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

Analyzované druhy symbolů

Můžete nakonfigurovat druhy symbolů, které budou analyzovány tímto pravidlem. Povolené hodnoty jsou:

  • Namespace
  • NamedType
  • Method
  • Property
  • Event
  • Parameter

Oddělte více hodnot čárkou (,). Výchozí hodnota obsahuje všechny druhy symbolů v předchozím seznamu.

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event