扩展 API
Visual Studio Code 的设计宗旨是可扩展性。从用户界面到编辑体验,VS Code 的几乎每个部分都可以通过扩展 API 进行自定义和增强。事实上,VS Code 的许多核心功能都是作为扩展构建的,并使用相同的扩展 API。
本文档介绍
代码示例可在 Microsoft/vscode-extension-samples 获取。
如果你正在寻找已发布的扩展,请前往 VS Code 扩展市场。
扩展能做什么?
以下是一些使用扩展 API 可以实现的功能示例
- 使用颜色或文件图标主题更改 VS Code 的外观 - 主题
- 在 UI 中添加自定义组件和视图 - 扩展工作台
- 创建一个 Web 视图以显示使用 HTML/CSS/JS 构建的自定义网页 - Web 视图指南
- 支持一种新的编程语言 - 语言扩展概览
- 支持调试特定的运行时 - 调试器扩展指南
如果你想更全面地了解扩展 API,请参阅扩展功能概览页面。扩展指南概览还包括示例代码和指南列表,它们演示了各种扩展 API 的用法。
如何构建扩展?
构建一个好的扩展需要花费大量时间和精力。API 文档的每个部分都可以帮助你做到以下几点
- 入门 部分通过 Hello World 示例教授构建扩展的基础概念。
- 扩展功能 部分将 VS Code 庞大的 API 分解为更小的类别,并引导你了解更详细的主题。
- 扩展指南 包括解释 VS Code 扩展 API 特定用法的指南和代码示例。
- 用户体验指南 展示了在扩展中提供出色用户体验的最佳实践。
- 语言扩展 部分通过指南和代码示例说明了如何添加对编程语言的支持。
- 测试与发布 部分包含关于各种扩展开发主题的深入指南,例如测试和发布扩展。
- 高级主题 部分解释了高级概念,例如扩展主机、支持远程开发和 GitHub Codespaces 以及Proposed API。
- 参考 部分包含 VS Code API、贡献点和许多其他主题的详尽参考。
最新动态?
VS Code 每月更新一次,扩展 API 也是如此。新功能和 API 每月都会推出,以增强 VS Code 扩展的功能和范围。
为了及时了解扩展 API 的最新动态,你可以查看每月发布说明,其中包含专门的部分介绍
- 扩展创作 - 了解最新版本中可用的新扩展 API。
- Proposed 扩展 API - 查看即将推出的 Proposed 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 提交新问题。