首页
/ 微软 Visual Studio 编辑器 API 指南

微软 Visual Studio 编辑器 API 指南

2024-09-09 11:54:52作者:江焘钦

项目介绍

微软 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的功能,满足各种开发需求。

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

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
576
107
Ffit-framework
面向全场景的 Java 企业级插件化编程框架,支持聚散部署和共享内存,以一切皆可替换为核心理念,旨在为用户提供一种灵活的服务开发范式。
Java
111
13
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
285
74
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
44
29
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
204
50
LangBotLangBot
😎丰富生态、🧩支持扩展、🦄多模态 - 大模型原生即时通信机器人平台 | 适配 QQ / 微信(企业微信、个人微信)/ 飞书 / 钉钉 / Discord / Telegram 等消息平台 | 支持 OpenAI GPT、ChatGPT、DeepSeek、Dify、Claude、Gemini、Ollama、LM Studio、SiliconFlow、Qwen、Moonshot、ChatGLM 等 LLM 的机器人 / Agent | LLM-based instant messaging bots platform, supports Discord, Telegram, WeChat, Lark, DingTalk, QQ, OpenAI ChatGPT, DeepSeek
Python
7
1
RGF_CJRGF_CJ
RGF是Windows系统下的通用渲染框架,其基于Direct3D、Direct2D、DXGI、DirectWrite、WIC、GDI、GDIplus等技术开发。RGF仓颉版(后续简称"RGF")基于RGF(C/C++版)封装优化而来。RGF为开发者提供轻量化、安全、高性能以及高度一致性的2D渲染能力,并且提供对接Direct3D的相关接口,以满足开发者对3D画面渲染的需求。
Cangjie
11
0
omega-aiomega-ai
Omega-AI:基于java打造的深度学习框架,帮助你快速搭建神经网络,实现模型推理与训练,引擎支持自动求导,多线程与GPU运算,GPU支持CUDA,CUDNN。
Java
11
2
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
59
47
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
900
0