CA1725:参数名应与基方法中的声明保持一致

属性
规则 ID CA1725
标题 参数名应与基方法中的声明保持一致
类别 命名
修复是中断修复还是非中断修复 重大
在 .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