VS Code 插件开发文档

Appearance

查看英文原始文档

术语表和说明 ​

26.08.21 版本说明 ​

本文档采用了全新的 vitepress 架构，大幅更新了文档中过时的部分，修复了大量资源链接也同时补充了大量内容，但是依旧保留了本项目的特色术语提示和原文档链接。在 AI 时代下，本文档依旧提供给学有余力的“人”。作为系统性文档，它在这个时代依旧能够指导人去处理 AI 编程犯的错误，同时也能让你更好地理解 VS Code 插件开发模式。本次改版中也采用了大量 AI 翻译辅助，不过还是由译者校审，翻译过程依旧可能存在错误情况，望读者不吝指教。

提问、纠错和参与 ​

  • 提问：欢迎大家在issue区对插件开发进行提问，虽然这里不是官方答疑平台，不过你可以在这里和国内的插件开发者进行交流。

  • 纠错和润饰：在翻译过程中难免会出现笔误、翻译不到位、存在优化空间等情况，当然最严重的应属于翻译的章节或者片段难以理解，请在issue中不吝赐教，我们会优先处理这类问题。

  • 参与：本项目会采取较为严格的翻译审查，若你有热情一同学习和贡献自己的力量，请参考我们的开发和翻译指南。

术语表 ​

术语表收录出现在VS Code中独有的或是易引起歧义的词汇，不包含常见词汇，如Extension。该表按首字母排序。 该表格式：

  • 普通词汇 英文名称 术语名称
  • 单义词 [出处或参考解释链接]() 术语名称：解释
  • 多义词 [出处或参考解释链接]() 术语名称1/术语名称2：解释
  • Activation Events 激活事件激活事件用于激活插件的VS Code事件钩子。：用于激活插件的VS Code事件钩子。
  • Contribution Points 配置点配置点package.json的一部分，用于配置插件启动命令、用户可更改的插件配置，可以理解为插件的主要配置文件。：package.json的一部分，用于配置插件启动命令、用户可更改的插件配置，可以理解为插件的主要配置文件。
  • Debug Adapter 调试适配器调试适配器连接真正的调试程序（或运行时）和调试界面的插件称之为调试适配器。VS Code没有原生调试程序，而是依赖【调试器插件】调用通信协议（调试适配器协议）和VS Code的调试器界面实现。：连接真正的调试程序（或运行时）和调试界面的插件称之为调试适配器调试适配器连接真正的调试程序（或运行时）和调试界面的插件称之为调试适配器。VS Code没有原生调试程序，而是依赖【调试器插件】调用通信协议（调试适配器协议）和VS Code的调试器界面实现。。VS Code没有原生调试程序，而是依赖【调试器插件】调用通信协议（调试适配器调试适配器连接真正的调试程序（或运行时）和调试界面的插件称之为调试适配器。VS Code没有原生调试程序，而是依赖【调试器插件】调用通信协议（调试适配器协议）和VS Code的调试器界面实现。协议）和VS Code的调试器界面实现。
  • Extension Manifest 插件清单插件清单VS Code自定义的pacakge.json文件，其中包含着插件的入口、配置等重要信息。：VS Code自定义的pacakge.json文件，其中包含着插件的入口、配置等重要信息。
  • Extensibility 扩展性
  • Extension Host 扩展主机扩展主机与VS Code主进程隔离的插件进程，插件运行的地方，开发者可在这个进程中调用VS Code提供的各类API。：与VS Code主进程隔离的插件进程，插件运行的地方，开发者可在这个进程中调用VS Code提供的各类API。
  • Language Servers 语言服务器语言服务器插件模式中使用C/S结构的的服务器端，用于高消耗的特殊插件场景，如语言解析、智能提示等。与之相对，客户端则是普通的插件，两者通过VS Code 的API进行通信。：插件模式中使用C/S结构的的服务器端，用于高消耗的特殊插件场景，如语言解析、智能提示等。与之相对，客户端则是普通的插件，两者通过VS Code 的API进行通信。
  • Language Identifier 语言标识符语言标识符定义在配置点的特定标识/名称，便于后续引用该语言配置。通常为某种编程语言的通俗名称，如JavaScript的语言标识符是【javascript】，Python的语言标识符是【python】。：定义在配置点配置点package.json的一部分，用于配置插件启动命令、用户可更改的插件配置，可以理解为插件的主要配置文件。的特定标识/名称，便于后续引用该语言配置。通常为某种编程语言的通俗名称，如JavaScript的语言标识符语言标识符定义在配置点的特定标识/名称，便于后续引用该语言配置。通常为某种编程语言的通俗名称，如JavaScript的语言标识符是【javascript】，Python的语言标识符是【python】。是【javascript】，Python的语言标识符语言标识符定义在配置点的特定标识/名称，便于后续引用该语言配置。通常为某种编程语言的通俗名称，如JavaScript的语言标识符是【javascript】，Python的语言标识符是【python】。是【python】。
  • Provider 供应器供应器也叫提供者，一种微软主导的设计模式，类似于策略模式。主要用于服务的提供和注入，在 VS Code 插件开发中主要用于注册功能函数。：也叫提供者，一种微软主导的设计模式，类似于策略模式。主要用于服务的提供和注入，在 VS Code 插件开发中主要用于注册功能函数。