扩展 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 Dev Slack:面向扩展开发人员的公开聊天室。VS Code 团队成员经常加入对话。
要对文档提供反馈,请在 Microsoft/vscode-docs 上创建新的问题。如果你有找不到答案的扩展问题,或者与 VS Code 扩展 API 相关的问题,请在 Microsoft/vscode 上打开新的问题。