CA1700: Non denominare 'Reserved' i valori di enumerazione

  • Articolo
Proprietà valore
ID regola CA1700
Titolo Non denominare 'Reserved' i valori di enumerazione
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Il nome di un membro di enumerazione contiene la parola "reserved".

Descrizione regola

Questa regola presuppone che un membro di enumerazione con un nome che contiene la parola "reserved" non sia attualmente utilizzato, ma sia un segnaposto che dovrà essere rinominato o rimosso in una versione futura. La ridenominazione o rimozione di un membro è ritenuta una modifica sostanziale. Non è consigliabile che gli utenti ignorino un membro solo perché il nome contiene "riservato", né è possibile affidarsi agli utenti per leggere o rispettare la documentazione. Inoltre, poiché i membri riservati vengono visualizzati nei browser degli oggetti e negli ambienti di sviluppo integrato intelligente, possono causare confusione sui membri effettivamente usati.

Anziché usare un membro riservato, aggiungere un nuovo membro all'enumerazione nella versione futura. Nella maggior parte dei casi l'aggiunta del nuovo membro non è una modifica di rilievo, purché l'aggiunta non causi la modifica dei valori dei membri originali.

In un numero limitato di casi l'aggiunta di un membro è una modifica che causa un'interruzione anche quando i membri originali mantengono i valori originali. Principalmente, il nuovo membro non può essere restituito dai percorsi di codice esistenti senza interrompere i chiamanti che usano un'istruzione switch (Select in Visual Basic) sul valore restituito che include l'intero elenco di membri e che generano un'eccezione nel caso predefinito. Un problema secondario è che il codice client potrebbe non gestire la modifica del comportamento da metodi di reflection, ad System.Enum.IsDefinedesempio . Di conseguenza, se il nuovo membro deve essere restituito da metodi esistenti o un'incompatibilità dell'applicazione nota si verifica a causa di un utilizzo di reflection insufficiente, l'unica soluzione non di interruzione consiste nel:

  1. Aggiungere una nuova enumerazione contenente i membri originali e nuovi.

  2. Contrassegnare l'enumerazione originale con l'attributo System.ObsoleteAttribute .

    Seguire la stessa procedura per tutti i tipi o i membri visibili esternamente che espongono l'enumerazione originale.

Come correggere le violazioni

Per correggere una violazione di questa regola, rimuovere o rinominare il membro.

Quando eliminare gli avvisi

È possibile eliminare un avviso da questa regola per un membro attualmente usato o per le librerie che in precedenza sono state spedite.

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

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

CA2217: Non contrassegnare le enumerazioni con FlagsAttribute

CA1712: Non usare nomi di tipo come prefisso nei valori di enumerazione

CA1028: L'archivio di enum deve essere Int32

CA1008: Gli enum devono avere valore zero

CA1027: Contrassegnare le enumerazioni con FlagsAttribute