VS 2022中为C#项目添加StyleCop自定义规则的方法

针对Visual Studio 2022 + .NET Core 6场景，旧版StyleCop的教程确实不适用——现在主流用的是基于Roslyn的StyleCopAnalyzers，下面是自定义嵌套层级检查规则的具体步骤：

1. 搭建分析器项目 #

• 新建类库项目（.NET Standard 2.0）：Roslyn分析器需要该框架兼容VS2022及.NET6环境
• 安装NuGet包：Microsoft.CodeAnalysis.Analyzers 和 Microsoft.CodeAnalysis.CSharp，选适配.NET6的稳定版本（如4.0.1）

2. 编写嵌套检测核心逻辑 #

创建继承自DiagnosticAnalyzer的类，实现语法树遍历与嵌套层级计算：

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

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class NestedBlockAnalyzer : DiagnosticAnalyzer
{
    // 规则元数据，可自定义ID、级别等
    public const string DiagnosticId = "CustomStyle001";
    private const string Title = "代码块嵌套层级超标";
    private const string MessageFormat = "当前代码块嵌套层级超过 {0} 层";
    private const string Category = "Style";

    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
        DiagnosticId, Title, MessageFormat, Category, 
        DiagnosticSeverity.Warning, isEnabledByDefault: true);

    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

    public override void Initialize(AnalysisContext context)
    {
        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
        context.EnableConcurrentExecution();
        // 监听所有代码块节点
        context.RegisterSyntaxNodeAction(AnalyzeBlockNode, SyntaxKind.Block);
    }

    private void AnalyzeBlockNode(SyntaxNodeAnalysisContext context)
    {
        var block = (BlockSyntax)context.Node;
        int currentNesting = 0;
        SyntaxNode parentNode = block.Parent;

        // 向上遍历语法树，统计嵌套层级
        while (parentNode != null)
        {
            if (parentNode is BlockSyntax || 
                parentNode is IfStatementSyntax || 
                parentNode is ForStatementSyntax || 
                parentNode is ForeachStatementSyntax || 
                parentNode is WhileStatementSyntax || 
                parentNode is DoStatementSyntax)
            {
                currentNesting++;
            }
            parentNode = parentNode.Parent;
        }

        // 自定义最大允许嵌套层级，这里设为3
        const int MaxAllowedNesting = 3;
        if (currentNesting > MaxAllowedNesting)
        {
            var diagnostic = Diagnostic.Create(Rule, block.GetLocation(), MaxAllowedNesting);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

3. 打包为可复用的NuGet包 #

• 编辑分析器项目的.csproj文件，添加NuGet打包配置：

<PropertyGroup>
  <PackageId>YourCustomStyleCopRules</PackageId>
  <Version>1.0.0</Version>
  <Authors>YourName</Authors>
  <Description>自定义代码嵌套层级检查规则</Description>
  <PackageTags>Roslyn;Analyzer;StyleCop;C#</PackageTags>
  <IncludeBuildOutput>false</IncludeBuildOutput>
</PropertyGroup>

<ItemGroup>
  <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" />
</ItemGroup>

• 右键项目选择打包，生成.nupkg格式的NuGet包

4. 在目标项目中启用规则 #

• 在你的.NET Core 6项目中，安装刚才生成的NuGet包
• 若没有.editorconfig文件，新建一个，添加规则配置（可调整级别为error/warning/suggestion）：

dotnet_diagnostic.CustomStyle001.severity = warning

• 重启VS2022，代码中嵌套超过3层的块会自动被标记出警告

扩展优化建议 #

• 可扩展检测范围：比如加入SwitchStatementSyntax、TryStatementSyntax等节点，覆盖更多控制流场景
• 支持动态配置：通过读取.editorconfig的自定义属性，让用户可自行设置最大嵌套层级，无需修改分析器代码
• 添加单元测试：使用Microsoft.CodeAnalysis.Testing框架编写测试用例，验证规则逻辑的正确性

内容的提问来源于stack exchange，提问作者Fernando Diaz Rojas