删除未使用的参数 (IDE0060)

属性
规则 ID IDE0060
标题 删除未使用的参数
类别 Style
Subcategory 不必要的代码规则(参数首选项)
适用的语言 C# 和 Visual Basic
选项 dotnet_code_quality_unused_parameters

概述

此规则用于标记未使用的参数。

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

选项

选项值指定是否应仅为非公共方法或公共和非公共方法标记未使用的参数。

若要了解如何配置选项,请参阅选项格式

dotnet_code_quality_unused_parameters

属性 说明
选项名称 dotnet_code_quality_unused_parameters
选项值 all 标记具有包含未使用的参数的任何可访问性的方法
non_public 只标记包含未使用的参数的非公共方法
默认选项值 all
// dotnet_code_quality_unused_parameters = all
public int GetNum1(int unusedParam) { return 1; }
internal int GetNum2(int unusedParam) { return 1; }
private int GetNum3(int unusedParam) { return 1; }

// dotnet_code_quality_unused_parameters = non_public
internal int GetNum4(int unusedParam) { return 1; }
private int GetNum5(int unusedParam) { return 1; }
' dotnet_code_quality_unused_parameters = all
Public Function GetNum1(unused As Integer)
    Return 1
End Function

Friend Function GetNum2(unused As Integer)
    Return 1
End Function

Private Function GetNum3(unused As Integer)
    Return 1
End Function

' dotnet_code_quality_unused_parameters = non_public
Friend Function GetNum4(arg1 As Integer)
    Return 1
End Function

Private Function GetNum5(arg1 As Integer)
    Return 1
End Function

抑制警告

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

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

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

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

若要禁用所有代码样式规则,请在配置文件中将类别 Style 的严重性设置为 none

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

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

另请参阅