扩展 API
Visual Studio Code 在设计时就考虑了可扩展性。从 UI 到编辑体验,VS Code 的几乎所有部分都可以通过扩展 API 进行自定义和增强。事实上,许多 VS Code 的核心功能都是作为扩展构建的,并使用了相同的扩展 API。
本文档描述了
代码示例可在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 的最新动态,您可以查阅每月的发布说明,其中包含专门介绍以下内容的章节:
寻求帮助
如果您有关于扩展开发的问题,请尝试在以下地方提问:
- VS Code 讨论:GitHub 社区,用于讨论 VS Code 的扩展平台,提出问题,帮助社区其他成员,并获得答案。
- Stack Overflow:有数千个标记为
vscode-extensions的问题,其中超过一半已经有答案。搜索您的问题,提出疑问,或者通过回答 VS Code 扩展开发问题来帮助您的开发者同仁! - VS Code 开发 Slack:面向扩展开发者的公开聊天室。VS Code 团队成员经常参与讨论。
要对文档提供反馈,请在Microsoft/vscode-docs创建新问题。如果您有找不到答案的扩展问题,或者对 VS Code 扩展 API 有疑问,请在Microsoft/vscode打开新问题。