扩展 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 Discussions:GitHub 社区,用于讨论 VS Code 的扩展平台、提问、帮助社区其他成员以及获取答案。
- Stack Overflow:有数千个标记为
vscode-extensions
的问题,其中一半以上已经有了答案。搜索您的问题,提出问题,或者通过回答 VS Code 扩展开发问题来帮助您的同行开发者! - VS Code Dev Slack:面向扩展开发者的公共聊天室。VS Code 团队成员经常参与讨论。
要对文档提供反馈,请在 Microsoft/vscode-docs 创建新问题。如果您有找不到答案的扩展问题,或遇到 VS Code 扩展 API 的问题,请在 Microsoft/vscode 创建新问题。