在 VS Code 中尝试！

扩展 API

Visual Studio Code 在设计之初就考虑了可扩展性。从 UI 到编辑体验，VS Code 的几乎每个部分都可以通过扩展 API 进行自定义和增强。事实上，VS Code 的许多核心功能都是作为扩展构建的，并使用相同的扩展 API。

本文档描述了

  • 如何构建、运行、调试、测试和发布扩展
  • 如何利用 VS Code 丰富的扩展 API
  • 在哪里可以找到指南和代码示例来帮助你入门
  • 遵循我们的UX 指南以获取最佳实践

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

如果你正在寻找已发布的扩展，请前往 VS Code 扩展市场。

扩展能做什么？

以下是你可以通过扩展 API 实现的一些示例

如果你想更全面地了解扩展 API，请参考扩展功能概述页面。扩展指南概述还包括一份代码示例和指南列表，说明了各种扩展 API 的用法。

如何构建扩展？

构建一个好的扩展可能需要大量时间和精力。API 文档的每个部分都可以帮助你完成以下工作

  • 入门部分通过Hello World示例教授构建扩展的基本概念。
  • 扩展功能将 VS Code 庞大的 API 分解为更小的类别，并为你指向更详细的主题。
  • 扩展指南包括解释 VS Code 扩展 API 特定用法的指南和代码示例。
  • UX 指南展示了在扩展中提供出色用户体验的最佳实践。
  • 语言扩展通过指南和代码示例说明如何添加对编程语言的支持。
  • 测试和发布包括关于各种扩展开发主题的深入指南，例如测试和发布扩展。
  • 高级主题解释了高级概念，例如扩展宿主、支持远程开发和 GitHub Codespaces 以及提议的 API。
  • 参考包含VS Code API、贡献点以及许多其他主题的详尽参考。

最新动态？

VS Code 每月更新，扩展 API 也不例外。每月都会有新的功能和 API 发布，以增强 VS Code 扩展的功能和范围。

为了跟上扩展 API 的最新进展，你可以查阅每月发布说明，其中包含专门的部分，涵盖

寻求帮助

如果你有扩展开发方面的问题，可以尝试在以下平台提问

  • VS Code Discussions：讨论 VS Code 扩展平台、提问、帮助社区其他成员并获取答案的 GitHub 社区。
  • Stack Overflow：有数千个带有 vscode-extensions 标签的问题，其中一半以上已经有答案。搜索你的问题，提问，或通过回答 VS Code 扩展开发问题来帮助你的同行开发者！
  • VS Code Dev Slack：面向扩展开发人员的公共聊天室。VS Code 团队成员经常参与讨论。

要对文档提供反馈，请在 Microsoft/vscode-docs 创建新问题。如果你有找不到答案的扩展问题，或 VS Code 扩展 API 的问题，请在 Microsoft/vscode 创建新问题。

06/12/2025