CA2217: Nie oznaczaj wyliczeń za pomocą FlagsAttribute

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA2217
Stanowisko Nie oznaczaj typów wyliczeniowych atrybutem Flags
Kategoria Użycie
Poprawka powodująca niezgodność lub niezgodność Niezgodność
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Wyliczenie jest oznaczone znakiem FlagsAttribute i zawiera co najmniej jedną wartość, która nie ma uprawnień dwóch lub kombinacji innych zdefiniowanych wartości w wyliczeniem.

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 bazy kodu mają być uruchamiane w tej regule.

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órych częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. 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

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 wyliczenie , Daysktóre spełnia wymagania dotyczące oznaczania za pomocą FlagsAttributepolecenia :

[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: Oznacz typy wyliczeniowe atrybutem Flags

Zobacz też