CA1801: Nicht verwendete Parameter überprüfen.

  • Artikel
Eigenschaft Wert
Regel-ID CA1801
Titel Nicht verwendete Parameter überprüfen.
Kategorie Verwendung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend: Wenn der Member außerhalb der Assembly nicht sichtbar ist, unabhängig von der Änderung, die Sie vornehmen.

Nicht unterbrechend: Wenn Sie den Member so ändern, dass er den Parameter innerhalb seines Texts verwendet.

Unterbrechend: Wenn Sie den Parameter entfernen und dieser außerhalb der Assembly sichtbar ist.
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Eine Methodensignatur enthält einen Parameter, welcher nicht im Methodentext verwendet wird.

Diese Regel untersucht nicht die folgenden Arten von Methoden:

  • Methoden, auf die ein Delegat verweist.

  • Methoden, die als Ereignishandler verwendet werden.

  • Serialisierungskonstruktoren (siehe Richtlinien).

  • GetObjectData-Serialisierungsmethoden.

  • Methoden, die mit dem abstract-Modifizierer (MustOverride-Modifizierer in Visual Basic) deklariert wurden.

  • Methoden, die mit dem virtual-Modifizierer (Overridable-Modifizierer in Visual Basic) deklariert wurden.

  • Methoden, die mit dem override-Modifizierer (Overrides-Modifizierer in Visual Basic) deklariert wurden.

  • Methoden, die mit dem extern-Modifizierer (mit der Declare-Anweisung in Visual Basic) deklariert wurden.

Nach dieser Retel werden keine Parameter gekennzeichent, die mit dem Verwerfen-Symbol benannt werden, beispielsweise _, _1, und _2. Dies reduziert Warnungen bei Parametern, die für Signaturanforderungen benötigt werden, z. B. eine Methode, die als Delegat verwendet wird, ein Parameter mit speziellen Attributen oder ein Parameter, auf dessen Wert zur Laufzeit implizit von einem Framework zugegriffen wird, auf den jedoch nicht im Code verwiesen wird.

Hinweis

Diese Regel ist veraltet. Stattdessen wird IDE0060 verwendet. Informationen dazu, wie Sie das IDE0060-Analysetool beim Erstellen erzwingen, finden Sie unter Code-Stil-Analyse.

Regelbeschreibung

Überprüfen Sie Parameter in nicht virtuellen Methoden, die nicht im Methodentext verwendet werden, um sicherzustellen, dass keine Unrichtigkeit vorhanden ist, um den Zugriff darauf zu vermeiden. Nicht verwendete Parameter verursachen Wartungs- und Leistungskosten.

Manchmal kann ein Verstoß gegen diese Regel auf einen Implementierungsfehler in der Methode hinweisen. Beispielsweise sollte der Parameter im Methodentext verwendet werden. Unterdrückt Warnungen dieser Regel, wenn der Parameter aufgrund der Abwärtskompatibilität vorhanden sein muss.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, entfernen Sie den nicht verwendeten Parameter (eine unterbrechende Änderung) oder verwenden Sie den Parameter im Methodentext (eine nicht unterbrechende Änderung).

Wann sollten Warnungen unterdrückt werden?

Eine Warnung, die auf dieser Regel basiert, kann problemlos unterdrückt werden:

  • Im zuvor gelieferten Code, für den die Korrektur eine unterbrechende Änderung wäre.

  • Für den this-Parameter in einer benutzerdefinierten Erweiterungsmethode für Microsoft.VisualStudio.TestTools.UnitTesting.Assert. Die Funktionen in der Assert-Klasse sind statisch, sodass es nicht erforderlich ist, auf den this-Parameter im Methodentext zuzugreifen.

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

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.CA1801.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 Option nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Leistung) 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

Standardmäßig gilt die CA1801-Regel für alle API-Oberflächen (öffentlich, intern und privat).

Beispiel

Das folgende Beispiel zeigt zwei Methoden. Eine Methode verstößt gegen die Regel, und die andere Methode erfüllt die Regel.

// This method violates the rule.
public static string GetSomething(int first, int second)
{
    return first.ToString(CultureInfo.InvariantCulture);
}

// This method satisfies the rule.
public static string GetSomethingElse(int first)
{
    return first.ToString(CultureInfo.InvariantCulture);
}