如何为.NET项目创建编译器强制规则？

当然可以实现这类强制规则，以下是几种常用方案：

1. 使用Roslyn分析器（推荐） #

Roslyn是C#的编译器平台，你可以编写自定义分析器检测代码规范，并将违规设置为错误级别，违反规则时项目直接无法编译。

实现步骤示例： #

• 创建类库项目，引用Microsoft.CodeAnalysis和Microsoft.CodeAnalysis.CSharp NuGet包
• 编写分析器类，继承DiagnosticAnalyzer，重写SupportedDiagnostics和Initialize方法
• 在分析逻辑中，检测所有接口的命名是否以T开头，不符合则报告诊断错误
• 将分析器打包为NuGet包或直接引用到目标项目
• 在项目的.editorconfig或项目文件中，将该分析器的诊断级别设置为error

核心代码片段： #

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class InterfaceNamingAnalyzer : DiagnosticAnalyzer
{
    public const string DiagnosticId = "InterfaceNamingRule";
    private static readonly LocalizableString Title = "接口命名不符合规范";
    private static readonly LocalizableString MessageFormat = "接口 '{0}' 必须以'T'开头";
    private static readonly LocalizableString Description = "所有接口必须以'T'作为前缀命名";
    private const string Category = "Naming";

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

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

    public override void Initialize(AnalysisContext context)
    {
        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
        context.EnableConcurrentExecution();
        context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.NamedType);
    }

    private static void AnalyzeSymbol(SymbolAnalysisContext context)
    {
        var namedTypeSymbol = (INamedTypeSymbol)context.Symbol;
        if (namedTypeSymbol.TypeKind == TypeKind.Interface && !namedTypeSymbol.Name.StartsWith("T"))
        {
            var diagnostic = Diagnostic.Create(Rule, namedTypeSymbol.Locations[0], namedTypeSymbol.Name);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

2. 使用StyleCop Analyzers #

StyleCop是成熟的代码规范分析工具，通过NuGet安装StyleCop.Analyzers后，可自定义规则或修改现有规则级别：

• 默认没有强制T前缀的接口命名规则，你可以基于StyleCop的扩展机制添加自定义规则，或直接采用Roslyn分析器方案
• 在项目的stylecop.json或.editorconfig中，将自定义规则的级别设为error，违规会导致编译失败

3. 自定义MSBuild任务 #

编写MSBuild任务，在编译前扫描代码文件检查接口命名：

• 创建MSBuild任务类，继承Task，实现Execute方法，遍历项目中的.cs文件解析接口命名
• 若发现不符合规则的接口，调用Log.LogError方法触发编译错误
• 在项目文件中引入该任务，添加到编译前的目标中

这种方案相对繁琐，不如Roslyn分析器灵活，适合简单规则场景。

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