🚀 在 VS Code 中

扩展 API

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

本文档描述了

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

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

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

扩展可以做什么?

以下是你可以使用扩展 API 实现的一些示例

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

如何构建扩展?

构建一个好的扩展可能需要大量的时间和精力。以下是 API 文档的每个部分可以帮助你解决的问题

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

最新动态?

VS Code 每月更新一次,这也适用于扩展 API。每个月都会推出新的功能和 API,以增强 VS Code 扩展的功能和范围。

为了及时了解扩展 API 的最新信息,你可以查看每月发布说明,其中有专门的章节介绍

寻求帮助

如果你有关于扩展开发的问题,请尝试在以下位置提问

  • VS Code 讨论区:GitHub 社区,用于讨论 VS Code 的扩展平台、提问、帮助社区的其他成员并获得答案。
  • Stack Overflow:有 数千个问题 标记为 vscode-extensions,其中一半以上已经有答案。搜索你的问题,提问,或通过回答 VS Code 扩展开发问题来帮助你的开发者同行!
  • VS Code Dev Slack:面向扩展开发者的公共聊天室。VS Code 团队成员经常加入对话。

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