CA1725: Parameternamen sollten mit der Basisdeklaration übereinstimmen.

Artikel
09/07/2023

Eigenschaft	Wert
Regel-ID	CA1725
Titel	Parameternamen sollten mit der Basisdeklaration übereinstimmen.
Kategorie	Benennung
Fix führt oder führt nicht zur Unterbrechung	Breaking
Standardmäßig in .NET 8 aktiviert	Nein

Ursache

Der Name eines Parameters in einer Methodenaußerkraftsetzung stimmt nicht mit dem Namen des Parameters in der Basisdeklaration der Methode oder dem Namen des Parameters in der Schnittstellendeklaration der Methode überein.

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

Regelbeschreibung

Die konsistente Benennung von Parametern in einer Überschreibungshierarchie erhöht die Verwendbarkeit von Methodenüberschreibungen. Ein Parametername in einer abgeleiteten Methode, der vom Namen in der Basisdeklaration abweicht, kann zu Unklarheiten dahingehend führen, ob es sich bei der Methode um eine Überschreibung der Basismethode oder eine neue Überladung der Methode handelt.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, benennen Sie den Parameter so um, dass er der Basisdeklaration entspricht. Die Korrektur ist eine Breaking Change für sichtbare COM-Methoden.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel, außer für COM-sichtbare Methoden in Bibliotheken, die zuvor ausgeliefert wurden.

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

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

Einschließen bestimmter API-Oberflächen

Sie können diese Option nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Benennung) 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

Freigeben über