Share via

CA1717: Pouze výčty FlagsAttribute by měly mít názvy v množném čísle

  • Článek
Vlastnost Hodnota
ID pravidla CA1717
Název Pouze výčty FlagsAttribute by měly mít názvy v množném čísle
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 výčtu končí slovem v množném čísle a výčet není označen atributem System.FlagsAttribute .

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

Popis pravidla

Konvence vytváření názvů určují, že název množného čísla pro výčet označuje, že lze současně zadat více než jednu hodnotu výčtu. Říká FlagsAttribute kompilátorům, že výčet by měl být považován za bitové pole, které umožňuje bitové operace ve výčtu.

Pokud lze najednou zadat pouze jednu hodnotu výčtu, název výčtu by měl být jednoslovné slovo. Například výčet, který definuje dny v týdnu, může být určen pro použití v aplikaci, kde můžete zadat více dní. Tento výčet by měl mít název FlagsAttribute Days (Dny). Podobný výčet, který umožňuje zadat pouze jeden den, by neměl atribut a lze ho volat "Den".

Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). To zkracuje dobu potřebnou k získání nové softwarové knihovny a zvyšuje důvěru zákazníků, že knihovnu vyvinul někdo, kdo má zkušenosti s vývojem spravovaného kódu.

Jak opravit porušení

Zadejte název výčtu jednoslovné slovo nebo přidejte .FlagsAttribute

Kdy potlačit upozornění

Je bezpečné potlačit upozornění z pravidla, pokud název končí v jednotném slově.

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

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.CA1717.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í možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost 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

Viz také