是否应限制C#源生成器仅针对partial类型？求最佳实践指导

方案选择建议 #

微软在源生成器的官方指导中，优先推荐主动输出清晰的错误提示，也就是你列出的第2种方案，原因如下：

• 直接生成代码让编译器报错（方案1）：编译器默认错误信息通常指向生成的代码，开发者很难关联到自己忘记加partial修饰符的问题，排查成本极高，体验很差。
• 保留现有检查仅靠文档告知（方案3）：开发者往往不会主动查阅文档，遇到生成不生效的问题时会陷入困惑，增加不必要的沟通和排查时间。

方案2的具体实现方式：

• 在IIncrementalGenerator中，通过增量管道筛选出被标记了自定义特性但没有partial修饰符的类型节点。
• 使用GeneratorExecutionContext.ReportDiagnostic方法输出自定义诊断信息：

  var diagnostic = Diagnostic.Create(
      new DiagnosticDescriptor(
          id: "SG001",
          title: "类型需标记为partial",
          messageFormat: "应用了{0}特性的类型必须标记为partial才能生成增强代码",
          category: "SourceGenerator",
          DiagnosticSeverity.Error,
          isEnabledByDefault: true
      ),
      typeNode.GetLocation(),
      attributeName
  );
  context.ReportDiagnostic(diagnostic);
  

  这种方式能直接在开发者的代码编辑器中定位到问题类型，提示信息清晰明确，大幅降低排查难度。

额外优化方案 #

除了方案2，还可以结合以下小优化提升体验：

• 在自定义特性的XML注释中明确标注“此特性仅可应用于partial类型”，让开发者在使用特性时就能看到提示。
• 在源生成器的初始化阶段，添加对特性应用目标的验证逻辑，确保特性不会被错误应用到非类型节点（比如方法、字段）上。

官方参考与最佳实践 #

微软官方文档中，关于源生成器的最佳实践强调：

• 始终提供清晰的诊断信息，帮助开发者快速定位问题。
• 尽量在编译阶段就捕获错误，避免生成无效代码。
• 源生成器的行为应该是可预测的，通过明确的提示让开发者理解规则。

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