CA2217: Nie oznaczaj wyliczeń za pomocą FlagsAttribute

Właściwości	Wartość
Identyfikator reguły	CA2217
Tytuł	Nie oznaczaj enumów atrybutem FlagsAttribute
Kategoria	Użycie
Poprawka łamiąca lub nienaruszająca	Niezgodność
Domyślnie włączone na platformie .NET 10	Nie.
Zastosowane języki	C# i Visual Basic

Przyczyna

Wyliczenie jest oznaczone poprzez FlagsAttribute i zawiera co najmniej jedną wartość, która nie jest potęgą liczby dwa ani kombinacją innych zdefiniowanych wartości w wyliczeniu.

Domyślnie ta reguła analizuje tylko widoczne zewnętrznie wyliczenia, ale można to skonfigurować.

Opis reguły

Wyliczenie powinno być FlagsAttribute obecne tylko wtedy, gdy każda wartość zdefiniowana w wyliczenie jest potęgą dwóch lub kombinacją zdefiniowanych wartości.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, usuń FlagsAttribute ją z wyliczenia.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części kodu mają być objęte tą regułą.

• Uwzględnij określone powierzchnie interfejsu API

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, których dotyczy, lub dla wszystkich reguł w tej kategorii (użycie), do których ma ona zastosowanie. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na które części bazy kodu ma być stosowana ta reguła, na podstawie ich poziomu dostępu, ustawiając opcję api_surface. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Notatka

Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.

Przykłady

Poniższy kod przedstawia wyliczenie , Colorktóre zawiera wartość 3. 3 nie jest potęgą dwóch ani kombinacją żadnego ze zdefiniowanych wartości. Wyliczenie Color nie powinno być oznaczone znakiem 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

Poniższy kod przedstawia wyliczenieDays, które spełnia wymagania dotyczące oznaczenia przy użyciu polecenia 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

Powiązane reguły

CA1027: Oznacz typy wyliczeniowe atrybutem FlagsAttribute

Zobacz też

• System.FlagsAttribute