扩展API

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

本文档描述：

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

代码示例可从Microsoft/vscode-extension-samples获取。

如果您正在寻找已发布的扩展，请前往VS Code Extension Marketplace。

扩展可以做什么？

以下是使用扩展 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：有数千个已标记的问题visual-studio-code，其中一半以上已经有了答案。搜索您的问题、提出问题或通过回答 VS Code 扩展开发问题来帮助其他开发人员！
  • VS Code Dev Slack：扩展开发人员的公共聊天室。VS Code 团队成员经常加入对话。

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

11/1/2023