CA1005: Evitare un uso eccessivo di parametri nei tipi generici

  • Articolo
Proprietà valore
ID regola CA1005
Titolo Evitare un uso eccessivo di parametri nei tipi generici
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Un tipo generico visibile esternamente ha più di due parametri di tipo.

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

Descrizione regola

Quanto più è alto il numero di parametri di tipo contenuti, maggiore è la difficoltà di sapere e ricordare cosa rappresenta ciascun parametro. In genere è ovvio con un parametro di tipo, come in List<T>e in alcuni casi con due parametri di tipo, come in Dictionary<TKey, TValue>. Se esistono più di due parametri di tipo, la difficoltà diventa troppo grande per la maggior parte degli utenti, TooManyTypeParameters<T, K, V> ad esempio in C# o TooManyTypeParameters(Of T, K, V) in Visual Basic.

Come correggere le violazioni

Per correggere una violazione di questa regola, modificare la progettazione in modo da utilizzare non più di due parametri di tipo.

Quando eliminare gli avvisi

Non eliminare un avviso da questa regola a meno che la progettazione non richieda assolutamente più di due parametri di tipo. Fornire generics in una sintassi facile da comprendere e usare riduce il tempo necessario per apprendere e aumentare il tasso di adozione delle nuove librerie.

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

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.CA1005.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 (Progettazione) 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

CA1010: Le raccolte devono implementare un'interfaccia generica

CA1000: Non dichiarare membri statici su tipi generici

CA1002: Non esporre elenchi generici

CA1003: Usare istanze di gestori eventi generici

Vedi anche