插件 API 简介

VS Code 在设计之初就考虑到了插件。从 UI 设计到编辑体验，几乎 VS Code 每一部分都可以通过插件来定制或是加强。实际上，VS Code 很多核心的特性都是由插件的形式来构成的，并且它们都使用了相同的插件 API。

这个文档介绍了：

• 如何构建、运行、调试、测试和发布一个插件；

• 如何使用 VS Code 的丰富的插件 API；

• 如何找到 指南 和 代码示例 来帮助你开始开发；

• 最佳实践：跟随我们的 用户体验指南；

你可以在 Microsoft/vscode-extension-samples 找到代码示例。

如果你正在寻找已发布的插件，可以查看 VS Code 插件市场。

插件可以做什么

这里是一些例子，向你展示了你可以用插件 API 来做哪些事：

• 使用颜色或图标主题来改变 VS Code 的外观 - 主题。

• 在用户界面上添加定制的组件或视图 - 工作区插件。

• 创建一个 Webview 来展示一个使用 HTML/CSS/JS 开发的页面 - Webview 指南。

• 对一个编程语言提供支持 - 语言插件概览

• 对一个特定的运行时提供调试支持 - 调试器插件指南。

如果你想要对插件 API 有一个大致的概念，可以参考 插件功能概述。插件指南 同样包含了一个代码示例的列表和指南，举例说明了插件 API 的各种用法。

如何构建插件？

构建一个好的插件程序可能需要花费大量的时间和精力。下面是一些可能会对你有帮助的文档：

• 起步 通过构建一个 Hello World 的例子来讲解插件的基本概念。

• 插件功能 将 VS Code 众多繁杂的 API 分门别类为一个个的小类，并为你提供更详细的概括。

• 插件指南 包含指南和代码示例，解释了 VS Code 插件 API 的具体用法。

• 用户体验指南 展示了使用插件来提供良好用户体验的最佳实践。

• 语言插件 展示了如何使用指南和代码示例为编程语言提供支持。

• 测试和发布 包含了插件开发的深入指南，例如 插件的测试 和 插件的发布 插件。

• 高级 解释了一些高级的概念，例如 插件宿主、支持远程开发和 Github Codespaces 和 实验性 API。

• 参考 包含了 VS Code API、Contribution 配置项和其它主题的详细的参考。

What's new?

VS Code 按每个月一次的节奏更新，同样地，插件 API 也会更新。新特性和新 API 每个月都会更新，这样 VS Code 的插件功能每个月都会变得更强大。

想要了解插件 API 的最新情况，你可以查看月度发布说明，其中有专门的章节，涵盖了：

• 插件开发 - 最新发布的版本中有哪些新的可用的插件 API。

• 实验性 API - 查看即将到来的实验性 API 并给予反馈。

寻求帮助

如果你在插件开发的过程中需要帮助，你可以尝试在下面的平台或网站中提出问题：

• VS Code Discussions：在 Github 上讨论 VS Code 插件的社区，你可以在上面提问、帮助别人或者寻找答案。

• Stack Overflow：在这里，有成千上万个带有“vscode 插件”标签的问题，并且超过半数已经得到解答。在上面查找或提出你的问题，或者是帮助其它同样在学习 VS Code 插件开发的人解决问题！

• VS Code 开发者 Slack：公共的聊天室，VS Code 开发组成员经常参加讨论。

如果想要向文档提出反馈，你可以在 Microsoft/vscode-docs 提一个工单。如果你有关于插件的问题得不到答案，或者是你发现 VS Code 插件 API 存在问题，请在 Microsoft/vscode 提工单。

译者：如果这个中文文档存在问题，或者是你发现了翻译问题，请在对应的页面上点击 “在 Github/Gitee 上编辑”，来向我们提交 Pull Request.