扩展 API

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

此文档描述：

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

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

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

扩展程序可以做什么？

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

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

如果您想对扩展 API 有一个更全面的概述，请参阅扩展功能概述页面。扩展指南概述还包括一个列表，列出了说明各种扩展 API 用法的代码示例和指南。

如何构建扩展？

建立一个良好的扩展可能需要大量的时间和精力。以下是每个部分的API文档可以帮助你完成的事项：

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

有什么新内容？

VS Code 每月更新一次，扩展 API 也是一样。每个月都会提供新的功能和 API，以增强 VS Code 扩展的能力和范围。

为了保持对扩展 API 的最新了解，您可以查看每月的发布说明，其中包含专门的部分涵盖：

• 扩展编写 - 了解最新发布中可用的新扩展API。
• Proposed extension APIs - Review and give feedback on upcoming proposed APIs.

Looking for help

If you have questions for extension development, try asking on:

• VS Code Discussions: GitHub community to discuss VS Code's extension platform, ask questions, help other members of the community, and get answers.
• Stack Overflow: There are thousands of questions tagged vscode-extensions, and over half of them already have answers. Search for your issue, ask questions, or help your fellow developers by answering VS Code extension development questions!
• VS Code Dev Slack: Public chatroom for extension developers. VS Code team members often join in the conversations.

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