自定义Roslyn C#命名分析器跨项目引用时构建通过但Intellisense报错

问题场景 #

自定义Roslyn C#语义分析器，规则是根据父类的方法细节（如ParentEntity包含IsAwesome方法）强制子类命名（需以Awesome开头）。同一项目内，Intellisense和构建都会正常报错；但父类位于其他项目并通过PackageReference引用时，仅Intellisense显示错误，构建能正常通过。分析器为NuGet包，目标框架.NET Standard 2.0，适配.NET Standard 2.0和.NET Framework 4.7.2项目。

核心原因 #

Roslyn在设计时编译（Intellisense）和构建时编译的符号获取逻辑存在差异：

• 设计时编译会加载引用项目的完整符号信息（包括源码级符号），能识别父类的方法细节；
• 构建时默认仅加载引用程序集的元数据，若父类项目未输出符号文件，分析器无法获取方法的相关语义信息，导致诊断逻辑不触发。

解决方案 #

1. 确保父类项目输出完整符号文件 #

构建时分析器需要父类的符号信息才能正确检查方法细节，需让父类项目生成并打包符号文件：

• .NET Standard/.NET Core项目：在父类项目的.csproj中添加以下配置：

  <PropertyGroup>
    <DebugType>portable</DebugType>
    <DebugSymbols>true</DebugSymbols>
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
  </PropertyGroup>
  

• .NET Framework项目：确保生成.pdb文件，并在NuGet打包时包含该文件。可通过.nuspec文件配置：

  <files>
    <file src="bin/Release/ParentEntity.pdb" target="lib/net472" />
  </files>
  

2. 调整分析器逻辑，兼容元数据符号 #

若分析器依赖父类方法的实现细节（如方法体），元数据符号无法提供此类信息，需调整逻辑为基于元数据可获取的信息判断：

• 原逻辑可能依赖IMethodSymbol.Body，改为检查方法的名称、可访问性等元数据属性：

  // 替换原实现细节检查逻辑
  var hasAwesomeMethod = parentTypeSymbol.GetMembers("IsAwesome")
      .OfType<IMethodSymbol>()
      .Any(m => m.DeclaredAccessibility == Accessibility.Protected);
  

3. 确保分析器在构建时被正确加载 #

验证分析器NuGet包的结构是否符合规范，确保构建时MSBuild能自动加载：

• 分析器程序集需放在Nu包的analyzers/dotnet/cs目录下，手动打包时可在.nuspec中配置：

  <files>
    <file src="bin/Release/netstandard2.0/YourAnalyzer.dll" target="analyzers/dotnet/cs" />
    <file src="bin/Release/netstandard2.0/YourAnalyzer.pdb" target="analyzers/dotnet/cs" />
  </files>
  

• 对于.NET Framework项目，确保PackageReference未排除分析器：

  <PackageReference Include="YourAnalyzerPackage" Version="1.0.0">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
  

4. 强制构建时启用分析器诊断 #

在目标项目的.csproj或Directory.Build.props中添加配置，确保诊断级别为Error且构建时强制执行：

<PropertyGroup>
  <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
  <EnableNETAnalyzers>true</EnableNETAnalyzers>
</PropertyGroup>
<ItemGroup>
  <!-- 替换为你的分析器ID和诊断ID -->
  <DiagnosticSeverity Include="YourDiagnosticId" Value="Error" />
</ItemGroup>

验证步骤 #

1. 重新打包父类项目（包含符号文件）和分析器NuGet包；
2. 在目标项目中更新引用，执行Clean和Rebuild操作；
3. 确认构建时触发预期的诊断错误，无法正常通过构建。

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