通过 vscode.languages.registerHoverProvider 注册悬停提示,指定语言并实现 provideHover 方法返回自定义内容,支持文本、Markdown 及多语言扩展,结合上下文分析提升提示准确性。

在VSCode中实现自定义悬浮提示,需要通过扩展开发的方式注册一个“悬停信息提供程序”(Hover Provider)。这允许你在鼠标悬停在代码特定位置时,显示你定义的内容,比如文档说明、类型信息或自定义提示。
1. 注册 Hover Provider
要在你的VSCode扩展中添加自定义悬停提示,需使用 vscode.languages.registerHoverProvider 方法。你需要指定目标语言和一个提供者对象,该对象实现 provideHover 方法。
- 在 extension.ts 中导入必要的模块:
import * as vscode from 'vscode';
export function activate(context: vscode.ExtensionContext) {
const hoverProvider = vscode.languages.registerHoverProvider('javascript', {
provideHover(document, position, token) {
// 获取当前悬停位置的词
const wordRange = document.getWordRangeAtPosition(position);
const word = document.getText(wordRange);
if (word === 'myFunction') {
return new vscode.Hover('这是 myFunction 的自定义说明');
}
// 可返回 Markdown 内容
if (word === 'apiCall') {
const md = new vscode.MarkdownString('调用后端 API,参数:`url`, `data`');
md.isTrusted = true;
return new vscode.Hover(md);
}
}
});
context.subscriptions.push(hoverProvider);
}
2. 支持多种语言和复杂逻辑
你可以为不同语言注册多个 Hover Provider,比如同时支持 TypeScript 和 Python。也可以结合正则表达式或语法树(如 Tree-sitter)解析更复杂的上下文。
- 使用正则判断是否匹配特定模式
- 从外部文档、JSON 配置或 API 动态加载提示内容
- 配合 document.getText(range) 提取上下文代码片段进行分析
3. 增强提示体验:Markdown 与样式
VSCode 的 Hover 支持 Markdown 格式,可添加链接、代码块和加粗文字,提升可读性。
const md = new vscode.MarkdownString();
md.appendCodeblock('console.log("hello")', 'javascript');
md.appendText(' 点击了解详情 ').appendMarkdown('[文档](https://example.com)');
注意:默认情况下 Markdown 不执行脚本,isTrusted 设为 true 可启用更多功能(需用户信任扩展)。
基本上就这些。注册 Hover Provider 后,VSCode 会在用户悬停时自动调用你的逻辑,展示定制内容。适合用于内部工具、DSL 支持或增强语言提示。









