CA1714: Le enumerazioni con Flags devono avere nomi plurali

  • Articolo
Proprietà valore
ID regola CA1714
Titolo Le enumerazioni con Flags devono avere nomi plurali
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Un'enumerazione System.FlagsAttribute ha e il relativo nome non termina in 's'.

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

Descrizione regola

I tipi contrassegnati con FlagsAttribute hanno nomi plurali perché l'attributo indica che è possibile specificare più di un valore. Ad esempio, un'enumerazione che definisce i giorni della settimana potrebbe essere destinata all'uso in un'applicazione in cui è possibile specificare più giorni. L'enumerazione deve avere FlagsAttribute e può essere denominata 'Days'. Un'enumerazione simile che consente di specificare solo un singolo giorno non avrebbe l'attributo e potrebbe essere chiamata 'Day'.

Le convenzioni di denominazione forniscono un aspetto comune per le librerie destinate a Common Language Runtime. In questo modo si riduce la curva di apprendimento necessaria per le nuove librerie software e si aumenta la fiducia dei clienti che la libreria è stata sviluppata da un utente esperto nello sviluppo di codice gestito.

Come correggere le violazioni

Impostare il nome dell'enumerazione su una parola plurale o rimuovere l'attributo FlagsAttribute se non è necessario specificare contemporaneamente più valori di enumerazione.

Quando eliminare gli avvisi

È sicuro eliminare una violazione se il nome è una parola plurale ma non termina in 's'. Ad esempio, se l'enumerazione di più giorni descritta in precedenza era denominata "DaysOfTheWeek", ciò violava la logica della regola ma non la finalità. Tali violazioni devono essere eliminate.

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

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.CA1714.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 (denominazione) 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

Vedi anche