VSCode怎么利用HoverProvider自定义悬停内容

风雪大大_7211

风雪大大_7211

2026-10-24

950人浏览

原创

hover不显示主因是languageid不匹配,需确保registerhoverprovider、package.json和文件实际languageid三者一致;markdownstring需启用自动转义;providehover须异步且防超时;自定义hover应与原生提示合并而非覆盖。

vscode怎么利用hoverprovider自定义悬停内容

registerHoverProvider 的 languageId 必须精确匹配

Hover 不显示,八成是 documentSelector 里写的 languageId 和当前文件实际 languageId 对不上。比如你注册了 { language: 'javascript' },但打开的是 .ts 文件——它的真实 languageId 是 typescript,不是 javascript。

实操建议:

  • 按 Ctrl+Shift+P → 输入 Developer: Toggle Developer Tools → 在 Console 里执行 vscode.window.activeTextEditor?.document.languageId,直接看当前文件真实 ID
  • package.json 中 activationEvents 和 contributes.languages 要和注册时用的 ID 完全一致(比如都写 typescript,别混用 ts 或 js)
  • 注册 provider 时,优先用数组形式指定 selector:[{ language: 'typescript' }],比模糊的 { scheme: 'file' } 更可靠

provideHover 返回的 Hover 内容要防转义失效

返回空提示、格式错乱、链接不渲染,大概率是 Markdown 字符没转义。VSCode 的 MarkdownString 只支持有限内联语法,*、_、` 这些符号若未处理,整个内容会解析失败变成空白。

实操建议:

  • 构造时务必传 true 启用自动转义:new vscode.MarkdownString(text, true)
  • 避免用多行代码块 ``` —— Hover 里渲染异常,改用单行 `const x = 1`
  • 链接只能是绝对 URL(如 https://example.com)或 command: 协议(如 command:editor.action.formatDocument),./readme.md 这类相对路径无效
  • 图片不能用 file://,也不推荐 base64(体积大、加载慢)

provideHover 里不能做同步耗时操作

悬停卡顿、半天没反应、甚至提示“hover provider timed out”,基本是因为你在 provideHover 函数里干了同步重活:读文件、遍历 AST、调本地 HTTP 接口……这个函数必须快进快出。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

实操建议:

  • 所有 I/O 操作必须异步:用 fs.promises.readFile 替代 fs.readFileSync,并返回 Promise.resolve(new vscode.Hover(...))
  • 高频查询结果要缓存,比如按 document.uri.toString() + position.line 做 key 存进 Map
  • 加超时兜底:Promise.race([fetchHover(), new Promise(r => setTimeout(r, 800))]),避免 hang 死整个 hover 流程

自定义 Hover 和原生提示共存需手动合并

注册自己的 HoverProvider 后,原生类型提示、JSDoc、变量值预览默认就没了——VSCode 不会自动叠加,你得自己拉取并拼接。

实操建议:

  • 别直接 return 新 Hover,先调用 vscode.languages.getHoverProvider() 找到已注册的 provider(如果有),手动触发它获取原始内容
  • 把原生内容(Hover.contents)和你新增的 MarkdownString 合并进同一个 Hover 实例
  • 注意顺序:把用户最关心的信息放前面,比如先显示翻译结果,再附带类型信息
  • 如果只想要增强、不覆盖,返回 undefined 表示“我不处理,交给下一个 provider”

真正难的不是写几行 registerHoverProvider,而是判断该不该介入、何时介入、以及怎么跟语言服务器和平共处。很多插件 hover 失效,根本不是代码问题,是没想清楚自己到底在补全语义,还是在覆盖语义。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1435

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3032

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2029

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2607

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1838

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1262

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

514

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程