CA1710: Gli identificatori devono contenere il suffisso corretto

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

Causa

Un identificatore non ha il suffisso corretto.

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

Descrizione regola

Per convenzione, i nomi dei tipi che estendono determinati tipi di base o che implementano determinate interfacce o tipi derivati da questi tipi hanno un suffisso associato al tipo o all'interfaccia di base.

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.

Nella tabella seguente sono elencati i tipi di base e le interfacce associati ai suffissi.

Tipo di base/Interfaccia Suffisso
System.Attribute Attributo
System.EventArgs Eventargs
System.Exception Eccezione
System.Collections.ICollection Raccolta
System.Collections.IDictionary Dizionario
System.Collections.IEnumerable Raccolta
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue> Dizionario
System.Collections.Queue Raccolta o coda
System.Collections.Stack Raccolta o stack
System.Collections.Generic.ICollection<T> Raccolta
System.Collections.Generic.IDictionary<TKey,TValue> Dizionario
System.Data.DataSet DataSet
System.Data.DataTable Raccolta o DataTable
System.IO.Stream Stream
System.Security.IPermission Autorizzazione
System.Security.Policy.IMembershipCondition Condizione
Delegato del gestore eventi. Eventhandler

I tipi che implementano ICollection e sono un tipo generalizzato di struttura dei dati, ad esempio un dizionario, uno stack o una coda, sono nomi consentiti che forniscono informazioni significative sull'utilizzo previsto del tipo.

I tipi che implementano ICollection e sono una raccolta di elementi specifici hanno nomi che terminano con la parola 'Collection'. Ad esempio, una raccolta di Queue oggetti avrà il nome 'QueueCollection'. Il suffisso 'Collection' indica che i membri della raccolta possono essere enumerati tramite l'istruzione foreach (For Each in Visual Basic).

Tipi che implementano IDictionary o IReadOnlyDictionary<TKey,TValue> hanno nomi che terminano con la parola 'Dictionary' anche se il tipo implementa IEnumerable o ICollection. Le convenzioni di denominazione dei suffissi 'Collection' e 'Dictionary' consentono agli utenti di distinguere tra i due modelli di enumerazione seguenti.

I tipi con il suffisso 'Collection' seguono questo modello di enumerazione.

foreach(SomeType x in SomeCollection) { }

I tipi con il suffisso 'Dictionary' seguono questo modello di enumerazione.

foreach(SomeType x in SomeDictionary.Values) { }

Un DataSet oggetto è costituito da una raccolta di DataTable oggetti, costituiti da raccolte di System.Data.DataColumn oggetti e System.Data.DataRow , tra gli altri. Queste raccolte vengono implementate ICollection tramite la classe base System.Data.InternalDataCollectionBase .

Come correggere le violazioni

Rinominare il tipo in modo che sia suffisso con il termine corretto.

Quando eliminare gli avvisi

È possibile eliminare un avviso per usare il suffisso 'Collection' se il tipo è una struttura di dati generalizzata che potrebbe essere estesa o che conterrà un set arbitrario di elementi diversi. In questo caso, un nome che fornisce informazioni significative sull'implementazione, sulle prestazioni o altre caratteristiche della struttura di dati può avere senso (ad esempio, BinaryTree). Nei casi in cui il tipo rappresenta una raccolta di un tipo specifico ,ad esempio StringCollection, non eliminare un avviso da questa regola perché il suffisso indica che il tipo può essere enumerato tramite un'istruzione foreach .

Per altri suffissi, non eliminare un avviso da questa regola. Il suffisso consente all'utilizzo previsto di essere evidente dal nome del tipo.

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

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

Escludere i tipi di base indiretti

È possibile configurare se escludere tipi di base indiretti dalla regola. Per impostazione predefinita, questa opzione è impostata su true, che limita l'analisi al tipo di base corrente.

dotnet_code_quality.CA1710.exclude_indirect_base_types = false

Suffissi obbligatori aggiuntivi

È possibile fornire suffissi obbligatori aggiuntivi o eseguire l'override del comportamento di alcuni suffissi hardcoded aggiungendo la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CA1710.additional_required_suffixes = [type]->[suffix]

Separare più valori con un | carattere. I tipi possono essere specificati in uno dei formati seguenti:

  • Solo nome di tipo (include tutti i tipi con il nome, indipendentemente dal tipo o dallo spazio dei nomi contenitore).
  • Nomi completi nel formato ID della documentazione del simbolo con un prefisso facoltativoT:.

Esempi:

Valore opzione Riepilogo
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class Tutti i tipi che ereditano da 'MyClass' devono avere il suffisso 'Class'.
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class|MyNamespace.IPath->Path Tutti i tipi che ereditano da 'MyClass' devono avere il suffisso 'Class' E tutti i tipi che implementano 'MyNamespace.IPath' devono avere il suffisso 'Path'.
dotnet_code_quality.CA1710.additional_required_suffixes = T:System.Data.IDataReader->{} Esegue l'override dei suffissi predefiniti. In questo caso, tutti i tipi che implementano 'IDataReader' non sono più necessari per terminare in 'Collection'.

CA1711: Gli identificatori non devono contenere un suffisso non corretto

Vedi anche