讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么使用Source Generator生成代码_C#编译时代码生成教程【精通】

云宇大大_4535

云宇大大_4535

发布时间:2026-05-08 16:47:19

|

553人浏览过

|

来源于php中文网

原创

Source Generator 不会自动生效,需项目配置、引用方式、接口实现和执行路径四者全部对齐;最常见失效原因是 Roslyn 未识别生成器,根源在于宿主项目未正确声明带 OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false" 的 ProjectReference。

c#怎么使用source generator生成代码_c#编译时代码生成教程【精通】

Source Generator 不会自动生效,哪怕代码写得完全正确——它依赖项目配置、引用方式、接口实现和执行路径四个环节全部对齐,缺一不可。

为什么 Execute 方法根本没被调用

最常见原因是 Roslyn 根本没“看到”你的生成器。这通常不是代码问题,而是宿主项目没正确声明 analyzer 引用。

  • ProjectReference 必须带两个属性:OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false";只加普通引用或 NuGet 包引用都不行
  • 目标项目必须是 SDK 风格项目(<Project Sdk="Microsoft.NET.Sdk">),且 <TargetFramework> 是 net5.0 或更高(netstandard2.0 不支持)
  • 生成器项目自身需设 <IsAnalyzer>true</IsAnalyzer>,并以 netstandard2.0 为目标框架(兼容性最佳)
  • [Generator] 特性必须来自 Microsoft.CodeAnalysis 命名空间,手误写成自定义同名特性或漏引用 Microsoft.CodeAnalysis.CSharp NuGet 包,就会静默失效

用 IIncrementalGenerator 而不是 ISourceGenerator

ISourceGenerator 已被标记为过时,全量执行模式会让构建速度随代码量线性下降;IIncrementalGenerator 是唯一推荐路径,靠显式声明依赖项来启用增量计算。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 在 Initialize 中不能做任何耗时操作或副作用,只允许注册管道(如 context.SyntaxProvider.CreateSyntaxProvider())
  • 过滤语法节点必须用 CreateSyntaxProvider,比如只处理带 [AutoNotify] 的属性,而不是在 Execute 里遍历所有 SyntaxTree
  • 语义模型必须通过 context.CompilationProvider 获取,不能在语法过滤阶段调用 GetSemanticModelAsync()
  • 最终必须链式调用 .Select().Collect().SelectMany().RegisterSourceOutput(),断掉任一环都会退化为全量执行

生成的代码不参与编译或报 CS0260 错误

生成的类型无法被识别,或出现 CS0260: Partial declarations must be in the same compilation unit,说明生成逻辑违反了 C# 编译约束。

  • 生成的文件名必须以 .g.cs 结尾(如 "MyViewModel.g.cs"),否则可能和手写文件冲突或被 IDE 忽略
  • 不能尝试用生成器去补全 partial class 的另一部分字段——C# 要求所有 partial 定义在同一编译单元可见,而 generator 输出是后置注入的
  • 生成类名时,务必用 INamedTypeSymbol.ContainingNamespace.ToDisplayString() 拼接,硬编码命名空间会导致跨命名空间重复定义
  • 生成内容必须是合法 C# 语法,且不能引用尚未生成的类型;若需依赖用户代码中的类型,必须通过 semanticModel.GetSymbolInfo() 获取符号,而非字符串匹配

调试时看不到生成的 .g.cs 文件

即使生成成功,VS 默认也不会显示这些文件,导致断点不命中、无法检查输出内容。

  • 必须在宿主项目的 .csproj 中显式启用:<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> 和 <CompilerGeneratedFilesOutputPath>obj/Generated</CompilerGeneratedFilesOutputPath>
  • VS 中需关闭“仅我的代码”(Tools → Options → Debugging → General → “Enable Just My Code”),否则调试器不会加载 obj/Generated 下的文件
  • 生成的文件实际路径是 obj/Generated/YourGeneratorName/FileName.g.cs,可直接用文件管理器打开验证内容
  • 不要在 Execute 中 throw new Exception(),这会让整个编译失败;改用 context.ReportDiagnostic() 发送诊断信息,它会在错误列表中显示

最容易被忽略的是增量管道的链式完整性:从 CreateSyntaxProvider 到 RegisterSourceOutput 中间任何一个 Select 或 Collect 没接上,都会让整个生成器退化为每次全量执行——性能损耗在中大型项目里几乎是不可接受的。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3169

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2308

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1240

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1198

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1356

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2158

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3460

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

15715

2023.09.22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

0

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn