VSCode扩展实现DocumentHighlightProvider的意义及相关问题咨询

1. 为VSCode扩展实现DocumentHighlightProvider的意义 #

这个接口的核心作用是为VSCode提供语义化的同符号多位置高亮能力。当用户将光标停在某个变量、函数、关键字等符号上时，VSCode可以自动在全文档范围内标记出所有和该符号相关的位置，用户无需手动搜索就能快速感知一个符号的所有出现场景，大幅提升代码阅读和编辑效率。
相较于VSCode默认的纯文本匹配高亮，自定义实现该接口可以结合扩展对应语言的语法、语义规则做精准匹配，比如只匹配同一作用域下的同名变量，不会把不同作用域的同名符号误判为同一目标，高亮准确率更高。

2. 如何在文档中查看text、read、write不同类型的单词高亮效果 #

首先确认当前使用的语言扩展已经实现了分类型的DocumentHighlight逻辑，之后按以下操作即可查看：

• 打开对应语言的代码文件，将光标移动到一个可读写的变量（比如普通局部变量）上，默认会自动触发全文档匹配高亮：
  • 仅做纯文本匹配、无语义关联的高亮属于Text类型，默认使用和编辑器主题匹配的浅色背景标记
  • 仅读取该变量值、没有做修改的位置属于Read类型，高亮样式和Text接近，部分主题会用稍深的背景做区分
  • 对该变量进行赋值、修改操作的位置属于Write类型，绝大多数主题会用偏蓝色的高亮背景或者明显的边框，和读操作做清晰区分
• 如果光标停驻后没有自动触发高亮，可以打开VSCode设置，搜索editor.occurrencesHighlight确认该配置项已经开启。

3. 每款VSCode扩展都有该接口的默认实现吗 #

不是，只有和代码编辑、语言支持相关的扩展才会按需实现该接口：

• VSCode官方内置支持的语言（比如JavaScript、TypeScript、Python等），默认自带语义级的DocumentHighlightProvider实现
• 第三方的语言类扩展、代码编辑辅助类扩展，会根据自身支持的语法特性，选择性实现这个接口
  其他类型的扩展比如主题扩展、代码片段扩展、效率工具类扩展，完全不需要用到这个接口，也就不会有相关实现。

内容的提问来源于stack exchange，提问作者ajayg