如何通过自定义Roslyn Analyzer在特定场景禁用Visual Studio默认规则

方案1：通过编译指令或EditorConfig配置屏蔽 #

• 适用场景：需要将屏蔽规则暴露给用户、或仅需要在部分代码位置固定屏蔽默认规则
• 实现方式：
  • 单文件/局部代码场景：当你的自定义规则触发时，可配套提供代码修复操作，自动在对应代码位置生成#pragma warning disable <默认规则ID>指令，精准屏蔽当前上下文的默认规则
  • 项目级特定场景：可自动修改项目的.editorconfig文件，配置默认规则的作用域过滤条件，比如仅对特定命名空间、特定后缀的文件禁用目标默认规则
• 前置要求：提前获取要屏蔽的VS默认规则的唯一ID，可在VS错误列表中右键对应规则查看属性获取。

方案2：使用Roslyn官方DiagnosticSuppressorAPI（推荐） #

这是Roslyn专门为按自定义条件屏蔽已有分析器规则设计的原生接口，无需修改用户代码或项目配置，所有逻辑封装在你的自定义Analyzer内部，对用户透明。

实现步骤： #

1. 新建类继承DiagnosticSuppressor抽象类，添加[DiagnosticAnalyzer(LanguageNames.CSharp)]/[DiagnosticAnalyzer(LanguageNames.VisualBasic)]特性指定支持的语言
2. 重写SupportedSuppressions属性，声明你要屏蔽的默认规则ID、你的抑制规则ID和说明
3. 重写ReportSuppressions方法，编写你的特定场景判断逻辑，满足条件时调用方法提交屏蔽请求即可

示例代码： #

using System.Collections.Immutable;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class CustomDefaultRuleSuppressor : DiagnosticSuppressor
{
    // 替换为你要屏蔽的默认规则ID，示例为IDE0007（使用var替代显式类型）
    private static readonly SuppressionDescriptor _suppressionRule = new(
        id: "CUSUP0001",
        suppressedDiagnosticId: "IDE0007",
        justification: "自定义规则覆盖场景下禁用该默认规则"
    );

    public override ImmutableArray<SuppressionDescriptor> SupportedSuppressions 
        => ImmutableArray.Create(_suppressionRule);

    public override void ReportSuppressions(SuppressionAnalysisContext context)
    {
        foreach (var diagnostic in context.ReportedDiagnostics)
        {
            // 这里编写你的特定场景判断逻辑
            var semanticModel = context.GetSemanticModel(diagnostic.Location.SourceTree);
            var targetNode = semanticModel.SyntaxTree.GetRoot(context.CancellationToken)
                .FindNode(diagnostic.Location.SourceSpan);
            
            // 当满足你自定义的屏蔽条件时执行屏蔽
            if (CheckIfSceneMatch(targetNode, semanticModel))
            {
                context.ReportSuppression(Suppression.Create(_suppressionRule, diagnostic));
            }
        }
    }

    private bool CheckIfSceneMatch(SyntaxNode targetNode, SemanticModel semanticModel)
    {
        // 实现你的场景判断逻辑，返回true表示需要屏蔽当前默认规则
        return true;
    }
}

内容的提问来源于stack exchange，提问作者silkfire