扩展API

Visual Studio Code 是以可扩展性为核心构建的。从用户界面到编辑体验,几乎 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 特定用途的指南和代码示例。
  • 用户体验指南 展示了在扩展中提供出色用户体验的最佳实践。
  • 语言扩展 说明了如何通过指南和代码示例添加对编程语言的支持。
  • 测试与发布 包含关于各种扩展开发主题的深入指南,例如 测试发布 扩展。
  • 高级主题 解释了高级概念,例如 扩展主机, 支持远程开发和GitHub Codespaces, 以及 提议的API.
  • 参考资料 包含了详尽的 VS Code API贡献点 以及许多其他主题的参考资料。

有什么新内容?

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

为了跟上扩展API的最新动态,您可以查看每月的发布说明,其中包含专门的部分涵盖:

寻求帮助

如果您对扩展开发有疑问,请尝试在以下地方提问:

  • VS Code Discussions: GitHub 社区,用于讨论 VS Code 的扩展平台,提出问题,帮助社区的其他成员,并获得答案。
  • Stack Overflow: 这里有成千上万的问题被标记为vscode-extensions,其中超过一半已经得到了解答。搜索你的问题,提问,或者通过回答VS Code扩展开发问题来帮助其他开发者!
  • VS Code Dev Slack: 扩展开发者的公共聊天室。VS Code 团队成员经常参与讨论。

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