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

  • Artikel
Eigenschaft Wert
Regel-ID CA1005
Titel Übermäßige Anzahl von Parametern in generischen Typen vermeiden.
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein extern sichtbarer generischer Typ weist mehr als zwei Typparameter auf.

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

Regelbeschreibung

Je mehr Typparameter ein generischer Typ enthält, desto schwieriger ist es, zu wissen und zu behalten, was die einzelnen Typparameter darstellen. Bei einem Typparameter, wie in List<T>, und in bestimmten Fällen auch bei zwei Typparametern, wie in Dictionary<TKey, TValue>, ist es normalerweise offensichtlich. Mehr als zwei Typparameter hingegen bereiten den meisten Benutzern Schwierigkeiten (z. B. TooManyTypeParameters<T, K, V> in C# oder TooManyTypeParameters(Of T, K, V) in Visual Basic).

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ändern Sie das Design so, dass nicht mehr als zwei Typparameter verwendet werden.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel, es sei denn, für das Design sind unbedingt mehr als zwei Typparameter notwendig. Durch das Bereitstellen von generischen Typen in einer Syntax, die leicht zu verstehen und zu verwenden ist, wird die zum Lernen erforderliche Zeit reduziert sowie die Übernahmerate neuer Bibliotheken erhöht.

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

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

CA1010: Sammlungen müssen eine generische Schnittstelle implementieren.

CA1000: Statische Member nicht in generischen Typen deklarieren.

CA1002: Generische Listen nicht verfügbar machen.

CA1003: Generische Ereignishandlerinstanzen verwenden.

Weitere Informationen