CA1711: Gli identificatori non devono contenere un suffisso non corretto

  • Articolo
Proprietà valore
ID regola CA1711
Titolo Gli identificatori non devono contenere un suffisso non corretto
Categoria Denominazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Un identificatore ha un suffisso non corretto.

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

Descrizione regola

Per convenzione, solo i nomi dei tipi che estendono determinati tipi di base o che implementano determinate interfacce o tipi derivati da questi tipi devono terminare con suffissi riservati specifici. Gli altri nomi di tipi non devono utilizzare questi suffissi riservati.

Nella tabella seguente sono elencati i suffissi riservati e i tipi di base e le interfacce a cui sono associati.

Suffisso Tipo di base/Interfaccia
Attributo System.Attribute
Sollecito System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Dizionario System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
Eventargs System.EventArgs
Eventhandler Delegato del gestore eventi
Eccezione System.Exception
Autorizzazione System.Security.IPermission
Coda System.Collections.Queue
Stack System.Collections.Stack
Stream System.IO.Stream

Inoltre, non è consigliabile usare i suffissi seguenti:

  • Delegate
  • Enum
  • Impl (usare Core invece)
  • Ex o suffisso simile per distinguerlo da una versione precedente dello stesso tipo
  • Flag o Flags per i tipi di enumerazione

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. Per altre informazioni, vedere Linee guida per la denominazione: classi, struct e interfacce.

Come correggere le violazioni

Rimuovere il suffisso dal nome del tipo.

Quando eliminare gli avvisi

Non eliminare un avviso da questa regola a meno che il suffisso abbia un significato ambiguo nel dominio dell'applicazione.

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

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.CA1711.severity = none

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

Configurare il codice da analizzare

Usare le opzioni seguenti per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare queste opzioni 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

Consenti suffissi

È possibile configurare un elenco di suffissi consentiti, con ogni suffisso separato dal carattere pipe ("|"). Ad esempio, per specificare che la regola non deve essere eseguita sui suffissi Flag e Flags, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

Vedi anche