删除不必要的抑制（IDE0079）

财产	价值
规则 ID	IDE0079
游戏	删除不必要的抑制
类别	CodeQuality
子类别	不必要的代码规则（抑制首选项）
适用的语言	C# 和 Visual Basic
选项	dotnet_remove_unnecessary_suppression_exclusions

概述

此规则标记源中不必要的杂注 杂注 和 SuppressMessageAttribute 属性抑制。

源抑制可禁止特定位置的编译器和分析器规则冲突，但不会在源代码的其他部分显示。 通常使用它们来禁止误报或不太重要的违规行为，而你不打算修复这些违规行为。 但是，抑制往往变得过时。 如果已修复规则以防止误报，或者重构代码，并且这样做，呈现抑制冗余，则可能会发生这种情况。 此规则有助于识别可以删除的冗余抑制。

注意

即使 在生成上启用代码样式规则，也不会启用此规则。 它仅在 Visual Studio 编辑器中浮出水面。

例

using System.Diagnostics.CodeAnalysis;

class C1
{
    // Necessary pragma suppression
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UnusedMethod() => 0;
#pragma warning restore IDE0051

    // IDE0079: Unnecessary pragma suppression
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UsedMethod() => 0;
#pragma warning restore IDE0051

    public int PublicMethod() => UsedMethod();
}

class C2
{
    // Necessary SuppressMessage attribute suppression
    [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
    private int _unusedField;

    // IDE0079: Unnecessary SuppressMessage attribute suppression
    [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
    private int _usedField;

    public int PublicMethod2() => _usedField;
}

选项

选项指定希望规则强制实施的行为。 有关配置选项的信息，请参阅 选项格式。

注意

设置格式 option_name = value:severity 的严重性不适用于 dotnet_remove_unnecessary_suppression_exclusions 选项，应避免。 而是使用单独的条目指定严重性，例如：

dotnet_remove_unnecessary_suppression_exclusions = none
dotnet_diagnostic.IDE0079.severity = warning

dotnet_remove_unnecessary_suppression_exclusions

财产	价值	描述
选项名称	dotnet_remove_unnecessary_suppression_exclusions
选项值	以逗号分隔的规则 ID 或类别列表（以 category:为前缀）	排除列出的规则或类别的抑制
	all	禁用规则（排除的所有规则 ID）
	none	为所有规则启用规则（无排除项）
默认选项值	none

using System.Diagnostics.CodeAnalysis;

class C1
{
    // 'dotnet_remove_unnecessary_suppression_exclusions = IDE0051'

    // Unnecessary pragma suppression, but not flagged by IDE0079
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UsedMethod() => 0;
#pragma warning restore IDE0051

    public int PublicMethod() => UsedMethod();
}

禁止显示警告

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

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

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

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

若要禁用此整个规则类别，请将类别的严重性设置为 配置文件中的 none。

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

有关详细信息，请参阅 如何取消代码分析警告。

另请参阅

• 杂注
• SuppressMessageAttribute
• 代码样式规则引用