CA1058: I tipi non devono estendere tipi di base specifici
Proprietà | valore |
---|---|
ID regola | CA1058 |
Title | I tipi non devono estendere tipi di base specifici |
Categoria | Progettazione |
La correzione causa un'interruzione o meno | Interruzione |
Abilitato per impostazione predefinita in .NET 9 | No |
Causa
Un tipo estende uno dei tipi di base seguenti:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.
Descrizione regola
Le eccezioni devono derivare da o una System.Exception delle relative sottoclassi nello spazio dei System nomi .
Non creare una sottoclasse di XmlDocument se si desidera creare una vista XML di un modello a oggetti o di un'origine dati sottostante.
Raccolte non generiche
Usare e/o estendere le raccolte generiche quando possibile. Non estendere le raccolte non generiche nel codice, a meno che non sia stata spedita in precedenza.
Esempi di utilizzo non corretto
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
Esempi di utilizzo corretto
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
Come correggere le violazioni
Per correggere una violazione di questa regola, derivare il tipo da un tipo di base diverso o da una raccolta generica.
Quando eliminare gli avvisi
Non eliminare un avviso da questa regola per le violazioni relative a ApplicationException. È possibile eliminare un avviso da questa regola per le violazioni relative XmlDocumenta . È possibile eliminare un avviso relativo a una raccolta non generica se il codice è stato rilasciato in precedenza.
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 CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
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.CA1058.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