启用EmitCompilerGeneratedFiles后二次编译出现成员重复定义问题

问题根源 #

• 二次编译时触发CS0111错误，是因为生成的代码被编译器重复纳入编译流程：开启EmitCompilerGeneratedFiles后，生成的代码会输出到指定目录，默认该目录下的.cs文件会被MSBuild自动加入编译，再加上源生成器本身会在编译过程中注入代码，导致同一代码被两次编译，触发重复定义错误。
• 添加<Compile Remove>后，虽然避免了重复编译，但同时让IDE和编译器完全忽略了该目录的生成文件，因此无法找到生成的模板方法。

正确解决方案 #

1. 调整项目配置：保留IDE可见性，排除重复编译 #

把原有<Compile Remove>配置替换为以下内容，确保生成文件能被IDE识别，但不会被重复编译：

<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
<!-- 核心配置：标记生成目录的文件为自动生成，MSBuild会自动排除编译但保留IDE可见 -->
<ItemGroup>
  <GeneratedFile Include="$(CompilerGeneratedFilesOutputPath)/**/*.cs" />
</ItemGroup>
<!-- 移除原来的<Compile Remove>配置 -->

如果使用较旧版本的MSBuild，也可以用以下配置替代：

<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
<ItemGroup>
  <Compile Remove="$(CompilerGeneratedFilesOutputPath)/**/*.cs" />
  <None Include="$(CompilerGeneratedFilesOutputPath)/**/*.cs" Visible="true" />
</ItemGroup>

2. 优化生成代码的结构 #

确保StringTemplateBuilder生成的代码满足以下要求：

• 生成的HtmlTemplates类为partial静态类：即使极端情况下重复生成，partial类也不会触发重复定义错误，示例结构如下：

namespace YourProjectNamespace;
public static partial class HtmlTemplates
{
    public static string MyTemplate()
    {
        return "<div>模板内容</div>";
    }
}

• 方法名唯一：根据模板文件名的哈希或完整路径生成唯一方法名，避免不同模板生成同名方法。

3. 增量源生成器的输入优化 #

确保只处理内容或路径发生变化的模板文件，避免无意义的重复生成：

IncrementalValuesProvider<AdditionalText> templateFiles = context.AdditionalTextsProvider
    .Where(static file => file.Path.EndsWith(".html"))
    .WithComparer(AdditionalTextComparer.Default); // 新增：仅处理变化的文件

AdditionalTextComparer是源生成器SDK提供的默认比较器，会自动检测文件路径和内容的变化，减少不必要的代码生成。

验证步骤 #

1. 执行dotnet clean清理旧的生成文件
2. 运行dotnet build编译项目，检查是否还有CS0111错误
3. 在代码中尝试调用HtmlTemplates.MyTemplate()，确认IDE能识别该方法且编译通过

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