概述页面

Visual Studio Code 从设计之初就将可扩展性作为核心考量。从用户界面到编辑体验,VS Code 几乎每一个部分都可以通过扩展 API 进行定制和增强。事实上,VS Code 的许多核心功能本身就是以扩展的形式构建的,并且使用的是同一套扩展 API。

本文档将带你快速建立对 VS Code 扩展开发的整体认识,包括:

  • 如何构建、运行、调试、测试和发布一个扩展
  • 如何充分利用 VS Code 丰富的扩展 API
  • 在哪里找到帮助你入门的指南和代码示例
  • 如何结合用户体验指南理解扩展设计的最佳实践

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

如果你正在寻找已发布的扩展,可以访问 Visual Studio Marketplace

扩展能做什么

以下是通过扩展 API 可以实现的一些典型能力:

  • 改变 VS Code 的外观:使用颜色主题或文件图标主题来定制编辑器界面,参考 Theming
  • 添加自定义组件和视图:扩展工作台 UI,例如侧边栏面板、活动栏入口等,参考 Extending Workbench
  • 创建 Webview:用 HTML、CSS、JavaScript 构建自定义界面,参考 Webview Guide
  • 支持新的编程语言:为语言提供语法高亮、补全、诊断等能力,参考 Language Extensions
  • 支持特定运行时的调试:为某类程序提供调试适配能力,参考 Debugger Extension

如果你想系统了解扩展 API 的全貌,可以继续阅读 Extension Capabilities OverviewExtension Guides Overview

如何学习扩展开发

构建一个优秀的扩展通常需要持续投入。为了帮助你更快建立完整认知,可以按下面的结构理解这套文档体系:

章节内容说明
入门通过 Hello World 示例理解扩展开发的基本概念
扩展能力按能力分类拆解 VS Code 扩展 API,并指向更细的专题
扩展指南通过指南和代码示例说明常见 API 的具体用法
用户体验指南总结扩展设计中的交互与体验最佳实践
语言扩展说明如何为编程语言提供支持
测试与发布讲解测试、打包、发布等工程化主题
高级主题介绍扩展主机、远程开发、提议 API 等进阶概念
参考手册提供 VS Code API、贡献点等详细参考信息

有哪些新内容

VS Code 每月都会发布更新,扩展 API 也会同步演进。每个月都会有新的特性和 API 推出,不断扩展扩展开发的边界和能力。

如果你想持续了解最新动态,可以关注 VS Code Release Notes,重点留意以下两类内容:

  • 扩展作者相关:查看每个版本新增了哪些扩展 API
  • 提议的扩展 API:了解仍在演进中的能力并及时给出反馈

寻求帮助

如果你在扩展开发中遇到问题,可以优先参考这些社区资源:

  • VS Code Discussions:GitHub 社区,用于讨论扩展平台、提问与交流经验
  • Stack Overflow:搜索或提问带有 vscode-extensions 标签的问题
  • VS Code Dev Slack:面向扩展开发者的公共聊天室,VS Code 团队成员也会参与讨论

如果你想针对官方文档提供反馈,可以在 microsoft/vscode-docs 提交 issue;如果你遇到扩展 API 本身的问题,可以在 microsoft/vscode 提交 issue。

下一步

如果你已经了解了扩展开发的大致范围,建议继续阅读 快速开始,先把开发环境、项目结构和最小可运行扩展串起来。