CA1717: Solo le enumerazioni con FlagsAttribute devono avere nomi plurali

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

Causa

Il nome di un'enumerazione termina in una parola plurale e l'enumerazione non è contrassegnata con l'attributo System.FlagsAttribute .

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

Descrizione regola

Le convenzioni di denominazione determinano che un nome plurale per un'enumerazione indica che è possibile specificare simultaneamente più di un valore dell'enumerazione. FlagsAttribute Indica ai compilatori che l'enumerazione deve essere considerata come un campo di bit che consente operazioni bit per bit sull'enumerazione.

Se è possibile specificare un solo valore di un'enumerazione alla volta, il nome dell'enumerazione deve essere una parola singolare. 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. Ciò riduce il tempo necessario per apprendere una nuova libreria software e 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 singolare o aggiungere .FlagsAttribute

Quando eliminare gli avvisi

È possibile eliminare un avviso dalla regola se il nome termina in una parola singolare.

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

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.CA1717.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