VSCode插件开发中怎么自定义悬停提示信息

胖强吖_4052

胖强吖_4052

2026-11-13

731人浏览

原创

Hover不生效主因是documentSelector与languageId不匹配,需用命令面板查vscode.window.activeTextEditor?.document.languageId确认真实ID,注册时用[{language:'typescript'}]等精确selector,避免缩写,并注意MarkdownString转义、异步操作及保存触发更新。

vscode插件开发中怎么自定义悬停提示信息

Hover 提示不生效,八成是 documentSelector 和实际文件的 languageId 对不上——不是你写错了,而是 VSCode 根本没把当前文件当你要支持的语言处理。

怎么确认当前文件真实 languageId

别猜,直接查。打开命令面板(Ctrl+Shift+P),运行 Developer: Toggle Developer Tools,切到 Console 标签页,输入:

vscode.window.activeTextEditor?.document.languageId

回车后看到的值才是真实 languageId。常见陷阱:

  • .ts 文件返回 typescript,不是 javascript
  • .vue 文件默认是 vue,但启用 <script setup></script> 后可能需要 vue-html 或 typescript 双 selector
  • package.json 是 json,不是 jsonc(除非你手动改了语言模式)

注册 HoverProvider 时 documentSelector 怎么写才有效

vscode.languages.registerHoverProvider() 的第一个参数必须和 package.json 中的 activationEvents 和 contributes.languages 严格一致。错一个字符就静默失败。

VSCode
VSCode

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

下载
  • 单语言:用数组 [{ language: 'typescript' }]
  • 多语言:写成 [{ language: 'typescript' }, { language: 'javascript' }]
  • 限定文件类型:比如只对 package.json 生效,用 { scheme: 'file', language: 'json', pattern: '**/package.json' }
  • 别写 js 或 ts ——VSCode 不认这种缩写

Hover 内容为空或格式乱码怎么办

返回的 vscode.MarkdownString 不是普通字符串,它对特殊字符敏感。反引号、星号、下划线不转义就会解析失败,结果就是悬停框空白。

  • 构造时传 true 启用自动转义:new vscode.MarkdownString('`x * y`', true)
  • 避免用多行代码块 ``` ——Hover 渲染器不支持,改用单行 `inline code`
  • 链接只能是 https:// 或 command: 协议,./readme.md 这种相对路径无效
  • 图片只接受网络 URL 或 base64(不推荐),file:// 路径被拦截

悬停卡顿或超时,问题出在 provideHover 是同步函数

provideHover 看似能返回 Thenable,但如果你在里面做 fs.readFileSync、遍历大数组、调外部 API,整个悬停就会卡住甚至无响应。

  • I/O 操作必须异步:fs.promises.readFile + return Promise.resolve(hover)
  • 高频查询结果要缓存,比如按 document.uri.toString() + position.line 做 Map 键
  • 加超时兜底:Promise.race([fetchPromise, new Promise(r => setTimeout(r, 500))])
  • 别在 provideHover 里启动新进程或加载大文件——用户悬停是毫秒级交互,不是后台任务

最常被忽略的一点:Hover 内容不会随源码实时更新。改了 JSDoc 或重新生成 AST 后,必须保存文件,VSCode 才会重新触发 provideHover。调试时别盯着没变的旧提示反复试。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1615

18

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

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

2023.07.21

3512

3

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

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

2024.03.14

2149

12

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

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

2024.03.14

1767

8

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

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

2024.03.15

2647

12

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

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

2024.03.15

1878

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1302

10

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

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

2024.03.15

1156

8

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

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

2024.03.15

574

5

热门下载

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

精品课程

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