CA1801:检查未使用的参数

  • 项目
属性 值
规则 ID CA1801
标题 检查未使用的参数
类别 使用情况
修复是中断修复还是非中断修复 非中断性 - 无论进行了何种更改，如果成员在程序集外部不可见，则为非中断性修复。

非中断性 - 如果将成员更改为在其主体中使用参数，则为非中断性修复。

中断性 - 如果删除参数，并且该参数在程序集外可见，则为中断性修复。
在 .NET 8 中默认启用 否

原因

方法签名包含一个没有在方法主体中使用的参数。

此规则不检查以下几种方法：

  • 委托引用的方法。

  • 用作事件处理程序的方法。

  • 序列化构造函数（请参阅指南）。

  • 序列化 GetObjectData 方法。

  • 使用 abstract（在 Visual Basic 中为 MustOverride）修饰符声明的方法。

  • 使用 virtual（在 Visual Basic 中为 Overridable）修饰符声明的方法。

  • 使用 override（在 Visual Basic 中为 Overrides）修饰符声明的方法。

  • 使用 extern（在 Visual Basic 中为 Declare 语句）修饰符声明的方法。

此规则不会标记以丢弃符号命名的参数，例如 __1 和 _2。 这可以降低签名要求所需参数的警告干扰，例如，用作委托的方法、具有特殊属性的参数或其值在运行时由框架隐式访问但未在代码中引用的参数。

注意

此规则已弃用，取而代之的是 IDE0060。 有关如何在生成时强制执行 IDE0060 分析器的信息，请参阅代码样式分析。

规则说明

查看未在方法体中使用的非虚拟方法中的参数，确保在访问失败时不存在错误。 未使用的参数会产生维护和性能费用。

有时，与此规则的冲突可能会导致方法中的实现 bug。 例如，应在方法主体中使用该参数的情况。 如果参数因为后向兼容性而必须存在，请禁止显示此规则发出的警告。

如何解决冲突

若要修复与此规则的冲突，请删除未使用的参数（中断性变更），或在方法主体中使用该参数（非中断性变更）。

何时禁止显示警告

在以下情况下，禁止显示此规则发出的警告是安全的：

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

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

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

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

有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别（性能）中的所有规则配置此选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal

默认情况下，CA1801 规则适用于所有 API 图面（公共、内部和私有）。

示例

下面的示例展示了两个方法。 其中一个方法违反了规则，而另一个方法符合规则。

// 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);
}