大网数据广告活动
.NET 与 C# 开发

.NET Compiler Platform SDK 概念和对象模型

· 52CE 我爱测

此概述提供了高效使用 .NET 编译器 SDK 所需的背景。 介绍了 API 层、涉及的主要类型以及总体对象模型。

编译器按照结构化规则处理代码,这些规则通常不同于用户读取和理解代码的方式。 基本了解编译器使用的模型对于了解生成基于 Roslyn 的工具时使用的 API 至关重要。

编译器管道功能区域

.NET Compiler Platform SDK 通过提供镜像传统编译器管道的 API 层,作为使用者向用户公开 C# 和 Visual Basic 编译器的代码分析。

编译器管道将源代码处理为对象代码的步骤

此管道的每个阶段都是一个单独的组件。 首先,分析阶段标记化源文本,并将其分析为遵循语言语法的语法。 随后,声明阶段分析源和导入的元数据,形成命名符号。 然后,绑定阶段将代码中的标识符与符号匹配。 最后,发出阶段发出所有信息均由编译器生成的程序集。

编译器管道 API 提供对编译器管道中包含的每个步骤的访问权限

.NET Compiler Platform SDK 对应于每个阶段提供一个对象模型,该模型允许访问该阶段的信息。 分析阶段公开一个语法树,声明阶段公开一个分层符号表,绑定阶段公开编译器语义分析的结果,发出阶段公开生成 IL 字节代码的 API。

编译器管道每个步骤的编译器 API 提供的语言服务

每个编译器将这些组件合并在一起,组成一个端到端整体。

这些 API 与 Visual Studio 使用的 API 相同。 例如,代码大纲和格式设置功能使用语法树,对象浏览器和导航功能使用符号表,重构和转到定义使用语义模型,编辑并继续使用所有这些信息,包括发出 API。

API 层

.NET 编译器 SDK 包含两个主要 API 层:编译器 API 和工作区 API。

由编译器管道 API 表示的 API 层

编译器 API

编译器层包含的对象模型(语法模型和语义模型)对应于在编译器管道的每个阶段公开的信息。 编译器层还包含编译器的单次调用的不可变快照,包括程序集引用、编译器选项和源代码文件。 C# 语言和 Visual Basic 语言由两个不同的 API 表示。 这两个 API 的形状类似,但针对每种语言的高保真进行了定制。 此层不包含 Visual Studio 组件的依赖项。

诊断 API

在编译器分析过程中,编译器会生成一组诊断,包括语法、语义、明确赋值以及各种警告和信息性诊断。 编译器 API 层通过一个可扩展 API 公开诊断,该可扩展 API 允许将用户定义的分析器插入编译过程。 它支持随编译器定义的诊断一起,生成用户定义的诊断,例如由 StyleCop 或 FxCop 等工具生成的诊断。 以这种方式生成诊断有以下优势:与 MSBuild 和 Visual Studio 等工具(具体取决于对根据策略停止生成等体验进行的诊断)自然地集成、在编辑器中显示实时波形曲线,以及建议代码修复。

脚本 API

托管 API 和脚本 API 是编译器层的一部分。 可使用它们来执行代码片段和累积运行时执行上下文。 C# 交互式 REPL (读取–求值–打印循环)可使用这些 API。 借助 REPL,可将 C# 用作脚本语言,在编写代码的同时,以交互方式执行代码。

工作区 API

工作区层包含工作区 API,是对整个解决方案执行代码分析和重构的起点。 它有助于将解决方案中项目的全部相关信息组织为单个对象模型,可让用户直接访问编译器层对象模型,而无需分析文件、配置选项,或管理项目到项目依赖项。

此外,工作区层还包含一组 API,用于实现在 Visual Studio IDE 等主机环境中使用的代码分析和重构工具。 相关示例包括查找所有引用、格式设置和代码生成 API。

此层不包含 Visual Studio 组件的依赖项。

历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / .NET 中文文档历史快照
适用范围
历史中文快照 2019-08-18;详见原文产品版本;文档日期 10/10/2017
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。