Teilen über

CA1002: Generische Listen nicht verfügbar machen.

  • Artikel
Eigenschaft Wert
Regel-ID CA1002
Titel Generische Listen nicht verfügbar machen.
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Typ enthält einen extern sichtbaren Member vom Typ System.Collections.Generic.List<T>, gibt einen List<T>-Typ zurück oder verfügt über eine Signatur mit einem List<T>-Parameter.

Standardmäßig werden mit dieser Regel nur extern sichtbare Typen überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

System.Collections.Generic.List<T> ist eine generische Auflistung, die auf Leistung und nicht auf Vererbung ausgerichtet ist. List<T> enthält keine virtuellen Member, die es einfacher machen, das Verhalten einer vererbten Klasse zu verändern. Die folgenden generischen Auflistungen sind auf eine Vererbung ausgerichtet und sollten anstelle von List<T> verfügbar gemacht werden.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ändern Sie den System.Collections.Generic.List<T>-Typ in eine der generischen Auflistungen, die auf eine Vererbung ausgelegt sind.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel, es sei denn, bei der Assembly, die diese Warnung auslöst, soll es sich nicht um eine wiederverwendbare Bibliothek handeln. Es wäre beispielsweise sicher, diese Warnung in einer leistungsoptimierten Anwendung zu unterdrücken, wenn durch die Verwendung generischer Listen eine Verbesserung der Leistung erzielt werden kann.

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

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

CA1005: Übermäßige Anzahl von Parametern in generischen Typen vermeiden.

CA1010: Sammlungen müssen eine generische Schnittstelle implementieren.

CA1000: Statische Member nicht in generischen Typen deklarieren.

CA1003: Generische Ereignishandlerinstanzen verwenden.

Weitere Informationen

Generics