如何为VSCode设置一个自定义的悬停信息提供程序？

vscode.languages.registerHoverProvider

activate

HoverProvider

provideHover

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    console.log('自定义悬停提供程序已激活！');

    // 注册一个Hover Provider
    // 第一个参数是文档选择器，这里我们选择JavaScript文件
    // 也可以是 { language: 'javascript', scheme: 'file' } 等更具体的选择器
    let disposable = vscode.languages.registerHoverProvider(
        'javascript', // 针对JavaScript文件
        {
            // provideHover 方法是核心，当鼠标悬停时会被调用
            provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): vscode.ProviderResult<vscode.Hover> {
                // 获取鼠标悬停位置的单词
                const range = document.getWordRangeAtPosition(position);
                if (!range) {
                    return undefined; // 如果没有单词，则不提供悬停信息
                }
                const word = document.getText(range);

                // 假设我们想为特定的单词提供悬停信息
                if (word === 'myCustomFunction') {
                    // 创建MarkdownString来支持富文本内容
                    const markdown = new vscode.MarkdownString();
                    markdown.appendMarkdown('### myCustomFunction()');
                    markdown.appendMarkdown('\n\n这是一个自定义的函数，用于演示悬停信息。');
                    markdown.appendCodeblock('console.log("Hello from custom function!");', 'javascript');
                    markdown.appendMarkdown('\n\n[查看更多文档](https://example.com/docs/myCustomFunction)');

                    // 返回一个Hover对象，包含内容和可选的范围
                    return new vscode.Hover(markdown, range);
                }

                // 如果不是我们关心的单词，则不提供悬停信息
                return undefined;
            }
        }
    );

    context.subscriptions.push(disposable);
}

export function deactivate() {}

myCustomFunction

vscode.MarkdownString

provideHover

async/await

vscode.ProviderResult<vscode.Hover>

undefined

Thenable<vscode.Hover>

selector

vscode.MarkdownString

const markdown = new vscode.MarkdownString();
markdown.appendMarkdown('### `myApi.fetchData(url: string)`');
markdown.appendMarkdown('\n\n用于从指定URL异步获取数据。');
markdown.appendCodeblock('const data = await myApi.fetchData("https://api.example.com/data");', 'typescript');
markdown.appendMarkdown('\n\n[查看API文档](https://example.com/api-docs#fetchData)');
markdown.appendMarkdown('\n\n[快速生成示例代码](command:myExtension.generateFetchExample)'); // 假设你有一个命令可以生成代码
markdown.isTrusted = true; // 如果包含command:链接，必须设置为true
return new vscode.Hover(markdown);

git