CA1002: Non esporre elenchi generici
Proprietà | valore |
---|---|
ID regola | CA1002 |
Title | Non esporre elenchi generici |
Categoria | Progettazione |
La correzione causa un'interruzione o meno | Interruzione |
Abilitato per impostazione predefinita in .NET 9 | No |
Causa
Un tipo contiene un membro visibile esternamente che è un System.Collections.Generic.List<T> tipo, restituisce un List<T> tipo o la cui firma include un List<T> parametro.
Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.
Descrizione regola
System.Collections.Generic.List<T> è una raccolta generica progettata per le prestazioni e non per l'ereditarietà. List<T> non contiene membri virtuali che semplificano la modifica del comportamento di una classe ereditata. Le raccolte generiche seguenti sono progettate per l'ereditarietà e devono essere esposte anziché List<T>.
Come correggere le violazioni
Per correggere una violazione di questa regola, modificare il System.Collections.Generic.List<T> tipo in una delle raccolte generiche progettate per l'ereditarietà.
Quando eliminare gli avvisi
Non eliminare un avviso da questa regola a meno che l'assembly che genera questo avviso non sia una libreria riutilizzabile. Ad esempio, sarebbe sicuro eliminare questo avviso in un'applicazione ottimizzata per le prestazioni in cui è stato ottenuto un vantaggio per le prestazioni dall'uso di elenchi generici.
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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002
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.CA1002.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
Regole correlate
CA1005: Evitare un uso eccessivo di parametri nei tipi generici
CA1010: Le raccolte devono implementare un'interfaccia generica
CA1000: Non dichiarare membri statici su tipi generici
CA1003: Usare istanze di gestori eventi generici