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

C# Roslyn操作代码文件 C#如何使用Roslyn API解析和生成C#源文件

胖强大大_3361

胖强大大_3361

发布时间:2026-03-18 11:58:00

|

513人浏览过

|

来源于php中文网

原创

CSharpSyntaxTree.ParseText需显式指定CSharpParseOptions语言版本,语法节点不可变须赋值接收ReplaceNode返回值,生成代码须用NormalizeWhitespace().ToFullString()并用SyntaxFactory构造合法节点。

c# roslyn操作代码文件 c#如何使用roslyn api解析和生成c#源文件

用 CSharpSyntaxTree.ParseText 读取源码时,别漏掉 ParseOptions

直接 CSharpSyntaxTree.ParseText("class A {}") 看似能跑,但一遇到 async、record、global using 就报错:「unexpected token」或语法树不完整。这是因为默认解析器只支持 C# 6 语法,而新版特性需要显式指定语言版本。

  • 必须传入 new CSharpParseOptions(LanguageVersion.CSharp12)(按项目实际版本选)
  • 如果源码含 UTF-8 BOM 或换行符异常,加 encoding: Encoding.UTF8 避免字符解析错位
  • 从文件读取时,优先用 CSharpSyntaxTree.ParseText(File.ReadAllText(path), options),别用 File.ReadAllBytes + Encoding 手动转——容易丢元数据(比如行号映射)

修改语法树后,root.ReplaceNode 不生效?检查是否用了不可变节点

Roslyn 的语法节点全是不可变(immutable)的,ReplaceNode 返回的是新树,原 root 变量没变。常见错误是写了 root.ReplaceNode(old, new) 却没接返回值,后续还拿旧 root 去生成代码,结果什么都没改。

  • 必须赋值: root = root.ReplaceNode(oldNode, newNode)
  • 批量替换用 root.ReplaceNodes,它接收一个 IEnumerable<syntaxnode></syntaxnode> 和转换函数,比循环调 ReplaceNode 安全(避免中间状态污染)
  • 如果要插入新节点(如加字段),别直接 new FieldDeclarationSyntax——得用 SyntaxFactory.FieldDeclaration 系列工厂方法,否则缺少必要的语法令牌(如分号、修饰符顺序)

生成字符串时,root.ToString() 和 root.NormalizeWhitespace().ToFullString() 差在哪

ToString() 只输出原始解析后的文本(缩进乱、缺换行、无空格),根本不能当源码用;ToFullString() 也不行——它保留所有原始空白,但没格式化逻辑。真正可用的是 NormalizeWhitespace() 后再 ToFullString()。

C#
C#

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

下载
  • NormalizeWhitespace() 会补全缺失的空格/换行(比如 if(x){} → if (x) { }),还能传参控制缩进风格(indentation: " ")
  • 若需匹配团队代码风格,建议额外用 Formatter.Format(root, workspace)(需引入 Microsoft.CodeAnalysis.Workspaces),但它依赖 AdhocWorkspace 和文档上下文,轻量脚本里慎用
  • 注意: NormalizeWhitespace 不改变语法结构,只是美化;如果节点本身缺 SemicolonToken,它不会帮你加——得先用工厂方法构造合法节点

引用 Microsoft.CodeAnalysis.CSharp 后,编译报错“找不到类型或命名空间”

常见于 .NET SDK 项目(Sdk="Microsoft.NET.Sdk"),因为 Roslyn 包默认不参与编译引用传递。即使 NuGet 装了,using Microsoft.CodeAnalysis 仍标红。

  • 必须在 .csproj 中显式设 <includesourcegeneratorattributes>true</includesourcegeneratorattributes>(非必需,但防坑)
  • 更关键的是加 <packagereference include="Microsoft.CodeAnalysis.CSharp" version="4.9.2" privateassets="all"></packagereference>,且 PrivateAssets="all" 要保留,否则可能和项目自带的编译器版本冲突
  • 如果用的是 .NET 8+,推荐统一用 Microsoft.CodeAnalysis.Common + CSharp 组合包,别混用 Microsoft.CodeAnalysis(旧全量包,已弃用)

语法树不是字符串拼接,节点关系、令牌位置、语义模型三者咬合很紧。少一个 SyntaxFactory.Token,或者忘了调 WithLeadingTrivia 补注释,生成的代码就可能编译失败——这种细节没报错提示,只能靠调试时看 root.ToFullString() 输出肉眼排查。

热门AI工具

更多
DeepSeek

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

1132

2023.08.08

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

3351

2023.08.31

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

945

2024.03.13

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2655

2024.03.14

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

352

2026.02.03

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

429

2026.02.06

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

631

2026.03.11

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

329

2026.04.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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