VSCode怎么自定义书签标记的悬停说明

小辰吖_6840

小辰吖_6840

2026-11-19

352人浏览

原创

VSCode书签悬停内容无法自定义,因Bookmarks插件未注册HoverProvider且书签非AST节点;唯一实用方案是使用命名书签配合侧栏列表预览代码行。

vscode怎么自定义书签标记的悬停说明

VSCode 默认不支持为书签(Bookmark)添加自定义悬停说明(Hover Tooltip),Bookmarks 插件本身不提供 hover 文本配置项,所有书签图标悬停时只显示固定格式的 file:line 信息,无法注入 JSDoc、注释或用户定义文本。

为什么书签悬停内容不能像函数那样用 JSDoc 控制

书签是编辑器侧边栏(gutter)的 UI 标记,不是语言语义节点——它不关联 AST、不参与类型检查,也不触发 LSP 的 provideHover。VSCode 的 hover 系统只响应语言服务器或扩展注册的 HoverProvider,而 Bookmarks 插件没注册该能力,也未暴露 API 给其他扩展劫持书签 hover 行为。

  • 你写的 /** @description ... */ 注释对书签 hover 完全无效
  • 即使给某行加了命名书签(如 auth-init),悬停时仍只显示 index.ts:42
  • 插件作者明确表示:hover 内容硬编码在 UI 层,无配置入口(见 GitHub issue #327)

唯一可行的变通方案:用命名书签 + 侧栏预览代替悬停

虽然不能改悬停,但 Bookmarks 插件的侧栏列表(Bookmarks: List Bookmarks)会显示每条书签的命名和**代码行片段**,这比默认 hover 更实用:

VSCode节点工具(专业版)
VSCode节点工具(专业版)

面向团队的企业级IDE远程操作平台,含调试、测试、终端、Agent委托与团队协作能力。

下载
  • 打命名书签:Ctrl+Alt+Shift+K(Win/Linux)→ 输入 db-connect-timeout
  • 打开侧栏:Ctrl+Shift+P → 输入 Bookmarks: List Bookmarks
  • 列表中每项含文件名、行号、以及该行前导空格+代码文本(最多约 60 字符)
  • 悬停侧栏条目时,VSCode 会显示完整代码行 tooltip —— 这是 VSCode 原生的“列表项 hover”,不可定制但足够看清上下文

想真正自定义悬停?只能自己写扩展注册 HoverProvider

如果你必须让鼠标悬停书签图标时显示自定义文字(比如从注释提取、或读取配置),就得开发一个轻量扩展,监听 gutter click/hover 事件并手动注入 tooltip。但这要绕过插件限制,且有明显缺陷:

  • VSCode 不允许扩展直接监听 gutter 图标 hover,只能监听整个 editor 区域的 onDidChangeTextEditorSelection 或 onDidMouseMove,再手动判断位置是否靠近书签图标 —— 容易误触、性能差
  • 返回的 Hover 对象必须绑定到某个 Range,而书签没有对应 Range(它只是装饰器),你得伪造一个覆盖行首的 range,导致悬停区域错位
  • 需重复实现书签状态同步(比如用户删了书签,你的 hover 还挂着旧信息)
  • documentSelector 必须匹配当前文件 languageId,否则 registerHoverProvider 根本不生效 —— 这点极易配错(比如 .ts 文件要用 typescript,不是 javascript)

真要这么做,核心陷阱只有一个:VSCode 的 gutter 图标不是文档内容的一部分,任何 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

1675

18

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

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

2023.07.21

3652

3

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

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

2024.03.14

2189

12

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

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

2024.03.14

1787

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

1176

8

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

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

2024.03.15

594

5

热门下载

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

精品课程

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