0

0

C# 源代码生成器调试方法 C#如何调试自己的Source Generator

月夜之吻

月夜之吻

发布时间:2026-03-17 12:43:02

|

601人浏览过

|

来源于php中文网

原创

Source Generator 不能直接 F5 调试,因其在编译期运行于 csc.exe 进程内、无独立入口点;需 Attach 到 csc.exe 并确保 Debug 配置与完整调试符号,配合 MSBuild 日志验证加载、或用 Debugger.Launch() 快速确认执行。

c# 源代码生成器调试方法 c#如何调试自己的source generator

Source Generator 调试为什么不能直接 F5?

因为 Source Generator 在编译期运行,不是普通可执行程序,没有入口点,Visual Studio 或 dotnet build 不会把它当独立进程启动。你加断点、按 F5,它根本不会命中——它跑在 csc.exe(C# 编译器)进程里,而且是跨进程、无调试符号加载的。

用 Attach to Process 强制挂载调试器

这是最可靠、最常用的调试方式。关键在于:必须在编译触发前就 attach 到正确的进程,并确保生成器代码已带调试符号(Debug 配置 + GenerateFullDebugSymbols)。

  • 在 Source Generator 项目中,确认 .csproj 包含:
    <PropertyGroup>
      <Configuration>Debug</Configuration>
      <GenerateFullDebugSymbols>true</GenerateFullDebugSymbols>
      <DebugType>portable</DebugType>
    </PropertyGroup>
  • 在调用方项目(即引用该 generator 的项目)中,右键 → “设为启动项目”,然后按 Ctrl+F5(不调试启动),让 VS 启动一个空壳进程(避免提前编译)
  • 在 VS 中:菜单栏 → “调试” → “附加到进程”,勾选“显示所有用户的进程”,查找并选中 csc.exe(注意:可能有多个,优先选命令行含 /analyzer: 或你 generator DLL 路径的那个)
  • 在 generator 代码中打上断点(比如 Execute 方法),再执行 dotnet build 或 Ctrl+Shift+B,断点就会被命中

启用 MSBuild 详细日志定位执行时机

有时候 attach 失败,是因为没抓到对的 csc.exe 实例,或者 generator 根本没被加载。这时要看 MSBuild 是否真把 analyzer 加进去了。

Spell.tools
Spell.tools

高颜值AI内容营销创作工具

下载
  • 在调用方项目目录下运行:dotnet build -v:detailed > build.log 2>&1
  • 打开 build.log,搜索 Analyzers 或你 generator 的 DLL 名,确认类似这一行出现:
    Using analyzers: C:\path\to\YourGenerator.dll
  • 如果没看到,检查 ProjectReference 是否用了 OutputItemType="Analyzer",或是否漏了 <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>

用 Console.WriteLine + Debugger.Launch() 快速验证流程

在开发早期,不想反复 attach,可以用“弹窗式调试”快速确认 generator 是否被调用、参数是否符合预期。

  • Execute 方法开头加:
    if (!Debugger.IsAttached)
        Debugger.Launch(); // 运行时弹出 VS 选择框
    Console.WriteLine($"Executing for {context.Compilation.AssemblyName}");
  • 注意:Debugger.Launch() 只在 Windows 上有效;Linux/macOS 可改用 System.Diagnostics.Process.Start("dotnet", "trace collect --process-id ...") 配合日志,但不如前者直接
  • 此方式适合单次验证,频繁使用会导致每次编译都弹窗,建议配合 #if DEBUG 条件编译

真正难的不是打断点,而是理解 generator 的生命周期绑定在编译器 pipeline 的哪个阶段——它没有“重试”“热重载”概念,改完代码必须 clean + rebuild 调用方项目,否则旧缓存的 generator 实例可能还在运行。别信 IDE 的“自动刷新”。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

847

2023.08.22

console接口是干嘛的
console接口是干嘛的

console接口是一种用于在计算机命令行或浏览器开发工具中输出信息的工具,提供了一种简单的方式来记录和查看应用程序的输出结果和调试信息。本专题为大家提供console接口相关的各种文章、以及下载和课程。

420

2023.08.08

console.log是什么
console.log是什么

console.log 是 javascript 函数,用于在浏览器控制台中输出信息,便于调试和故障排除。想了解更多console.log的相关内容,可以阅读本专题下面的文章。

544

2024.05.29

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1541

2023.07.26

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1172

2023.07.27

windows照片无法显示
windows照片无法显示

当我们尝试打开一张图片时,可能会出现一个错误提示,提示说"Windows照片查看器无法显示此图片,因为计算机上的可用内存不足",本专题为大家提供windows照片无法显示相关的文章,帮助大家解决该问题。

837

2023.08.01

windows查看端口被占用的情况
windows查看端口被占用的情况

windows查看端口被占用的情况的方法:1、使用Windows自带的资源监视器;2、使用命令提示符查看端口信息;3、使用任务管理器查看占用端口的进程。本专题为大家提供windows查看端口被占用的情况的相关的文章、下载、课程内容,供大家免费下载体验。

463

2023.08.02

windows无法访问共享电脑
windows无法访问共享电脑

在现代社会中,共享电脑是办公室和家庭的重要组成部分。然而,有时我们可能会遇到Windows无法访问共享电脑的问题。这个问题可能会导致数据无法共享,影响工作和生活的正常进行。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2362

2023.08.08

c++ 字符处理
c++ 字符处理

本专题整合了c++字符处理教程、字符串处理函数相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.03.17

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 11.5万人学习

C 教程
C 教程

共75课时 | 5.5万人学习

C++教程
C++教程

共115课时 | 22.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号