CA2217: Neoznačujte výčty pomocí FlagsAttribute

  • Článek
Vlastnost Hodnota
ID pravidla CA2217
Název Neoznačujte výčty pomocí FlagsAttribute
Kategorie Využití
Oprava způsobující chybu nebo chybu způsobující chybu Nenarušující
Povoleno ve výchozím nastavení v .NET 8 No

Příčina

Výčet je označený FlagsAttribute a má jednu nebo více hodnot, které nejsou mocninami dvou nebo kombinace ostatních definovaných hodnot v výčtu.

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

Popis pravidla

Výčet by měl obsahovat FlagsAttribute pouze v případě, že každá hodnota definovaná v výčtu je mocnina dvou nebo kombinace definovaných hodnot.

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, odeberte FlagsAttribute z výčtu.

Kdy potlačit upozornění

Nepotlačujte upozornění na toto pravidlo.

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 (použití), 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

Příklady

Následující kód ukazuje výčet, Colorkterý obsahuje hodnotu 3. 3 není mocnina dvou ani kombinace žádné z definovaných hodnot. Výčet Color by neměl být označený FlagsAttribute.

// Violates this rule    
[FlagsAttribute]
public enum Color
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

Imports System

Namespace Samples

    ' Violates this rule    
    <FlagsAttribute()> _
    Public Enum Color

        None = 0
        Red = 1
        Orange = 3
        Yellow = 4

    End Enum
End Namespace

Následující kód ukazuje výčet, Dayskterý splňuje požadavky pro označení FlagsAttribute:

[FlagsAttribute]
public enum Days
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

Imports System
Namespace Samples

    <FlagsAttribute()> _
    Public Enum Days

        None = 0
        Monday = 1
        Tuesday = 2
        Wednesday = 4
        Thursday = 8
        Friday = 16
        All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday

    End Enum
End Namespace

CA1027: Označte výčty pomocí FlagsAttribute

Viz také