CA1058: Typen sollten bestimmte Basistypen nicht erweitern.
| Eigenschaft | Wert |
|---|---|
| Regel-ID | CA1058 |
| Titel | Typen sollten bestimmte Basistypen nicht erweitern. |
| Kategorie | Design |
| Fix führt oder führt nicht zur Unterbrechung | Breaking |
| Standardmäßig in .NET 8 aktiviert | Nein |
Ursache
Ein Typ erweitert einen der folgenden Basistypen:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
Standardmäßig werden mit dieser Regel nur extern sichtbare Typen überprüft, aber dies ist konfigurierbar.
Regelbeschreibung
Ausnahmen sollten von System.Exception oder einer seiner Unterklassen im System-Namespace abgeleitet werden.
Erstellen Sie keine Unterklasse von XmlDocument, wenn Sie eine XML-Ansicht eines zugrunde liegenden Objektmodells oder einer zugrunde liegenden Datenquelle erstellen möchten.
Nicht generische Auflistungen
Verwenden und/oder erweitern Sie generische Sammlungen, wann immer möglich. Erweitern Sie keine nicht generischen Auflistungen in Ihrem Code, es sei denn, Sie haben sie vorher versendet.
Beispiele für die falsche Verwendung
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
Beispiele für die korrekte Verwendung
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
Behandeln von Verstößen
Um einen Verstoß gegen diese Regel zu beheben, leiten Sie den Typ von einem anderen Basistyp oder einer generischen Auflistung ab.
Wann sollten Warnungen unterdrückt werden?
Unterdrücken Sie keine Warnung von dieser Regel für Verstöße gegen ApplicationException. Es ist ungefährlich, eine Warnung aus dieser Regel für Verstöße gegen XmlDocument zu unterdrücken. Es ist ungefährlich, eine Warnung über eine nicht generische Auflistung zu unterdrücken, wenn der Code zuvor freigegeben wurde.
Unterdrücken einer Warnung
Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.
#pragma warning disable CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.
[*.{cs,vb}]
dotnet_diagnostic.CA1058.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.
Konfigurieren des zu analysierenden Codes
Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.
Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Entwurf) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.
Einschließen bestimmter API-Oberflächen
Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:
dotnet_code_quality.CAXXXX.api_surface = private, internal
