微软 Visual Studio 编辑器 API 指南

项目介绍

微软 Visual Studio 编辑器 API 是一个开放源代码库，提供了深入集成Visual Studio编辑器的能力。它包含了所有公共API定义及编辑器的一些底层实现部分，如文本模型、文本逻辑和编辑器基本操作子系统。此项目旨在帮助扩展开发者更紧密地与编辑器互动，其支持的层次在Visual Studio（Windows）和Visual Studio for Mac中均有体现，尽管不包括UI层（如WPF和Cocoa）。对于Mac版，最新版本引入了基于原生macOS的文本编辑器，利用Apple的核心技术提升性能和一致性。

项目快速启动

要迅速开始使用VS Editor API，首先确保你的开发环境已配置好Visual Studio 2019或Visual Studio for Mac 8.0及以上版本。然后，遵循以下步骤：

安装必要的NuGet包

如果你专注于Windows上的开发，可以通过NuGet包管理器安装以下核心包：

Install-Package Microsoft.VisualStudio.CoreUtility
Install-Package Microsoft.VisualStudio.Text.Data
Install-Package Microsoft.VisualStudio.Text.Logic
Install-Package Microsoft.VisualStudio.Text.UI

构建和引用项目

1. 克隆仓库

   git clone https://github.com/microsoft/vs-editor-api.git
   

2. 打开解决方案并构建
   使用Visual Studio或Visual Studio for Mac打开VSEditorCore.sln文件，然后直接从IDE中构建项目。编译后的assembly将位于仓库根目录下的bin/中。

如果你想创建本地的NuGet包用于测试或分发，可以在命令行执行：

msbuild /t:Pack

这将在_artifacts/nuget/目录下生成NuGet包。

应用案例和最佳实践

应用案例通常涉及创建编辑器插件，比如自定义语法高亮、代码补全服务或是编辑器界面的定制化。最佳实践中，开发者应：

• 利用API提供的接口进行文本操作而非直接修改文本视图。
• 确保扩展在不同版本的Visual Studio中保持兼容性。
• 遵循异步编程模式以提高编辑器响应速度，尤其是在处理大文件时。
• 在设计扩展时考虑可测试性和模块化。

示例代码片段展示如何简单地插入文本到编辑器中：

using Microsoft.VisualStudio.Text;
// 假设已有ITextBuffer对象textBuffer
var edit = textBuffer.CreateEdit();
edit.Insert(edit.Start, "Hello, VS Editor API!");
edit.Apply();

典型生态项目

虽然本仓库主要关注于编辑器核心API，但微软Visual Studio的生态系统广泛，许多扩展都利用这些API来增强功能，例如：

• EditorConfig插件：自动应用编码风格设置，跨项目保持一致性。
• Live Share：实现实时的代码共享和协作编程。
• Roslyn：用于编写C#和VB.NET的代码分析和重构工具。

这些生态项目的成功展示了通过正确使用VS Editor API，可以极大地丰富Visual Studio的功能，满足各种开发需求。

请注意，贡献至该项目核心代码目前可能不被接受，但对于仓库中的其他内容，如新样本等，依旧欢迎提交拉取请求。始终遵守微软的开源行为准则，共同维护健康、开放的开发环境。