删除不必要的抑制 (IDE0079)

  • 项目
属性 值
规则 ID IDE0079
标题 删除不必要的抑制
类别 CodeQuality
Subcategory 不必要的代码规则（抑制首选项）
适用的语言 C# 和 Visual Basic
选项 dotnet_remove_unnecessary_suppression_exclusions

概述

此规则标记源中不必要的 pragma 和 SuppressMessageAttribute 特性抑制。

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

注意

规则 IDE0079 仅标记在 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;
}

选项

选项指定你希望规则强制实施的行为。 若要了解如何配置选项，请参阅选项格式。

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

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

另请参阅