讲师中心 微信公众号
AI工具推荐 视频效率加速

通过VSCode插件开发实现自定义悬浮提示Hover功能的实现

冬婷小哥_2485

冬婷小哥_2485

发布时间:2026-08-23 09:09:24

|

835人浏览过

|

来源于php中文网

原创

Hover 不生效的主因是 documentSelector 与 languageId 不匹配,需确认文件真实 languageId、保持 package.json 配置一致、注册时使用精确匹配的 selector,并注意 Markdown 转义、异步操作及调试日志。

通过vscode插件开发实现自定义悬浮提示hover功能的实现

Hover 提示没反应?检查 languageId 和 documentSelector 配置是否匹配

VSCode 的 Hover 功能不会自动触发,必须显式注册对应语言的 documentSelector。常见错误是插件声明支持 "javascript",但实际打开的是 .ts 文件——TypeScript 文件的默认 languageId 是 "typescript",不是 "javascript"。

实操建议:

  • 用 editor.languageId 命令(Ctrl+Shift+P → “Developer: Toggle Developer Tools” → Console 输入 vscode.window.activeTextEditor?.document.languageId)确认当前文件真实 languageId
  • package.json 中 contributes.languages 列表要和 activationEvents 里的 onLanguage:xxx 一致
  • 注册 Hover provider 时,vscode.languages.registerHoverProvider() 的第一个参数必须是匹配的 documentSelector,例如 [{ language: 'typescript' }] 或 { scheme: 'file', language: 'json' }

Hover 内容显示为空或格式错乱?注意 Markdown 字符转义和行内样式限制

Hover 返回的 MarkdownString 不支持任意 HTML,仅支持有限的内联 Markdown(如 **bold**、`code`、[link](...)),且所有反引号、星号、下划线需手动转义,否则解析失败导致空白。

实操建议:

  • 用 new vscode.MarkdownString(text, true) 构造时传 true 启用严格转义(自动处理 _、*、` 等)
  • 避免在 Hover 中嵌入长代码块:多行 ``` 在 Hover 中渲染异常,改用单行 `inline code` 或精简为关键词高亮
  • 链接必须是绝对 URL 或 command: 协议,相对路径(如 ./readme.md)无效
  • 图片不支持本地 file:// 路径,只能用网络 URL 或 vscode-resource:(已弃用)或 base64 内联(不推荐)

Hover 触发位置不准或延迟高?别在 provideHover 里做同步耗时操作

provideHover 是同步函数,但 VSCode 允许返回 Thenable<Hover>。若你在其中读文件、调外部 API 或遍历大数组,会导致悬停卡顿甚至超时无响应。

VSCode
VSCode

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

下载

实操建议:

  • 所有 I/O 操作必须异步:用 fs.promises.readFile 替代 fs.readFileSync,并返回 Promise.resolve(hover)
  • 缓存高频查询结果(如 AST 节点信息),用 Map 按 document.uri.toString() + position.line 做键,避免重复解析
  • 设置超时兜底:Promise.race([fetchData(), new Promise(r => setTimeout(() => r(null), 300))]),防止网络请求拖垮体验
  • 不要在 provideHover 中调用 vscode.window.showInformationMessage 等 UI 弹窗——会阻塞主线程且违反 Hover 设计契约

调试 Hover 不生效?启用 trace 和日志定位拦截点

VSCode 不报错也不显示 Hover,往往是因为 provider 注册失败、selector 不匹配,或被其他插件覆盖。靠猜效率极低。

实操建议:

  • 在 activate() 开头加 console.log('Hover provider registered'),再打开开发者工具(Ctrl+Shift+P → “Developer: Toggle Developer Tools”)看控制台是否有输出
  • 在 provideHover 函数第一行加 console.log('provideHover called at', position),确认是否被调用
  • 启动插件时加 --log-level=trace 参数(终端运行 code --extensionDevelopmentPath=/path/to/your/ext --log-level=trace),搜索日志中 hover 或 registerHoverProvider
  • 禁用其他插件(尤其是 Prettier、ESLint、TypeScript 插件),排除 provider 被优先级更高者拦截的可能

Hover 表面简单,但 languageId 匹配、Markdown 安全性、异步边界和调试链路这四点,任一疏漏都会导致“写了却看不到”。最常被忽略的是 documentSelector 的精确性——它不是模糊匹配,而是严格按字符串比对,连大小写都敏感。

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

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

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

1235

2023.06.30

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

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

2592

2023.07.21

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

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

1889

2024.03.14

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

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

1707

2024.03.14

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

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

2587

2024.03.15

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

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

1798

2024.03.15

vscode用途介绍
vscode用途介绍

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

1242

2024.03.15

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

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

1096

2024.03.15

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn