CA1027: Contrassegnare le enumerazioni con FlagsAttribute

  • Articolo
Proprietà valore
ID regola CA1027
Titolo Contrassegnare le enumerazioni con FlagsAttribute
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Nessuna interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

I valori di un'enumerazione sono poteri di due o sono combinazioni di altri valori definiti nell'enumerazione e l'attributo System.FlagsAttribute non è presente. Per ridurre i falsi positivi, questa regola non segnala una violazione per le enumerazioni con valori contigui.

Per impostazione predefinita, questa regola esamina solo enumerazioni visibili esternamente, ma è configurabile.

Descrizione regola

Un'enumerazione è un tipo di valore che definisce un insieme di costanti denominate correlate. Applicare FlagsAttribute a un'enumerazione quando le costanti denominate possono essere combinate in modo significativo. Si consideri, ad esempio, un'enumerazione dei giorni della settimana in un'applicazione che tiene traccia delle risorse del giorno disponibili. Se la disponibilità di ogni risorsa viene codificata usando l'enumerazione presente FlagsAttribute , è possibile rappresentare qualsiasi combinazione di giorni. Senza l'attributo , è possibile rappresentare un solo giorno della settimana.

Per i campi che archiviano enumerazioni combinabili, i singoli valori di enumerazione vengono considerati gruppi di bit nel campo. Di conseguenza, tali campi vengono talvolta definiti campi di bit. Per combinare i valori di enumerazione per l'archiviazione in un campo di bit, usare gli operatori condizionali booleani. Per testare un campo di bit per determinare se è presente un valore di enumerazione specifico, utilizzare gli operatori logici booleani. Affinché un campo di bit archivii e recuperi correttamente i valori di enumerazione combinati, ogni valore definito nell'enumerazione deve essere una potenza di due. A meno che questo non sia così, gli operatori logici booleani non saranno in grado di estrarre i singoli valori di enumerazione archiviati nel campo.

Come correggere le violazioni

Per correggere una violazione di questa regola, aggiungere FlagsAttribute all'enumerazione .

Quando eliminare gli avvisi

Eliminare un avviso da questa regola se non si desidera che i valori di enumerazione siano combinabili.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

#pragma warning disable CA1027
// The code that's violating the rule is on this line.
#pragma warning restore CA1027

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

[*.{cs,vb}]
dotnet_diagnostic.CA1027.severity = none

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (Progettazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Esempio

Nell'esempio DaysEnumNeedsFlags seguente è un'enumerazione che soddisfa i requisiti per l'uso FlagsAttribute , ma non lo ha. L'enumerazione ColorEnumShouldNotHaveFlag non dispone di valori che sono poteri di due, ma specifica FlagsAttributeerroneamente . Ciò viola la regola CA2217: Non contrassegnare le enumerazioni con FlagsAttribute.

// Violates rule: MarkEnumsWithFlags.
public enum DaysEnumNeedsFlags
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

// Violates rule: DoNotMarkEnumsWithFlags.
[FlagsAttribute]
public enum ColorEnumShouldNotHaveFlag
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

Vedi anche