扩展 API

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

本文档介绍：

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

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

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

扩展能做什么？

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

• 使用颜色或文件图标主题更改 VS Code 的外观 - 主题化
• 在 UI 中添加自定义组件和视图 - 扩展工作台
• 创建 Webview 以显示使用 HTML/CSS/JS 构建的自定义网页 - Webview 指南
• 支持新的编程语言 - 语言扩展概述
• 支持调试特定的运行时 - 调试器扩展指南

如果您想更全面地了解扩展 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，您可以查阅每月发布说明，其中包含专门的部分涵盖：

• 扩展创作 - 了解最新版本中可用的新扩展 API。
• 建议的扩展 API - 审查即将推出的建议 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上提出新问题。