CA1725:パラメーター名は基本宣言と同一でなければなりません

  • [アーティクル]
プロパティ 値
ルール ID CA1725
Title パラメーター名は基本宣言と同一でなければなりません
[カテゴリ] 名前を付ける
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 いいえ

原因

メソッド オーバーライド内のパラメーターの名前が、メソッドの基本宣言内のパラメーターの名前またはメソッドのインターフェイス宣言内のパラメーターの名前と一致しません。

デフォルトでは、この規則の対象は外部から参照可能なメソッドのみですが、これは構成可能です。

規則の説明

オーバーライド階層のパラメーターに対する一貫性のある名前付けによって、メソッド オーバーライドの有用性が高まります。 派生メソッドのパラメーター名が基本宣言のパラメーター名と異なる場合、メソッドが基本メソッドのオーバーライドであるか、またはメソッドの新しいオーバーライドであるかについて混乱が生じる可能性があります。

違反の修正方法

この規則違反を修正するには、基本宣言に一致するようにパラメーターの名前を変更します。 この修正は、COM 参照可能なメソッドの破壊的変更です。

どのようなときに警告を抑制するか

以前に発行されたライブラリ内の COM 参照可能なメソッドを除き、この規則からの警告を抑制しないでください。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

#pragma warning disable CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

[*.{cs,vb}]
dotnet_diagnostic.CA1725.severity = none

詳細については、「コード分析の警告を抑制する方法」を参照してください。

分析するコードを構成する

次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。

このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (名前付け) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。

特定の API サーフェイスを含める

ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.CAXXXX.api_surface = private, internal