首页 > 开发工具 > VSCode > 正文

如何为VSCode添加自定义悬停提示和文档显示?

紅蓮之龍
发布: 2025-09-17 18:48:01
原创
853人浏览过
答案是通过编写VSCode扩展并注册HoverProvider,利用Markdown语法和代码解析实现自定义悬停提示。首先创建扩展项目,在package.json中声明语言支持,于extension.ts中注册HoverProvider,通过provideHover方法根据单词或上下文返回带格式的提示内容,如加粗文本、代码块等,结合LSP可实现更高级功能,调试时使用launch.json配置启动扩展宿主实例。

如何为vscode添加自定义悬停提示和文档显示?

简单来说,就是定制VSCode的鼠标悬停提示和文档显示,让它显示你想要的信息,比如函数的使用方法、变量的含义等等。

为VSCode添加自定义悬停提示和文档显示,可以通过编写VSCode扩展来实现。 这涉及到使用VSCode的扩展API,以及对语言服务器协议(LSP)的理解。

扩展实现悬停提示和文档显示

首先,你需要创建一个VSCode扩展项目。可以使用

yo code
登录后复制
命令来生成一个基本的扩展项目结构。 在扩展的
package.json
登录后复制
文件中,你需要声明对特定语言的支持,以及提供悬停提示和文档显示的功能。

{
  "name": "my-custom-hover",
  "displayName": "My Custom Hover",
  "description": "Adds custom hover information to VSCode",
  "version": "0.0.1",
  "engines": {
    "vscode": "^1.63.0"
  },
  "categories": [
    "Programming Languages"
  ],
  "activationEvents": [
    "onLanguage:python" // 激活语言
  ],
  "main": "./out/extension.js",
  "contributes": {
    "languages": [
      {
        "id": "python",
        "aliases": [
          "Python"
        ],
        "extensions": [
          ".py"
        ],
        "configuration": "./language-configuration.json"
      }
    ],
    "configurationDefaults": {
      "[python]": {
        "editor.hover.enabled": true
      }
    }
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./",
    "pretest": "npm run compile && npm run lint",
    "lint": "eslint src --ext ts",
    "test": "node ./out/test/runTest.js"
  },
  "devDependencies": {
    "@types/vscode": "^1.63.0",
    "@types/glob": "^7.1.4",
    "@types/mocha": "^9.0.0",
    "@types/node": "16.x",
    "@typescript-eslint/eslint-plugin": "^5.9.1",
    "@typescript-eslint/parser": "^5.9.1",
    "eslint": "^8.6.0",
    "glob": "^7.1.7",
    "mocha": "^9.1.3",
    "typescript": "^4.5.4",
    "@vscode/test-electron": "^2.0.3"
  }
}
登录后复制

extension.ts
登录后复制
文件中,你需要注册一个
HoverProvider
登录后复制
,它负责在鼠标悬停时提供信息。

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {

  let disposable = vscode.languages.registerHoverProvider('python', {
    provideHover(document, position, token) {
      const word = document.getText(document.getWordRangeAtPosition(position));

      if (word === 'my_variable') {
        return new vscode.Hover(`This is a custom hover for the variable 'my_variable'. It stores important data.`);
      }

      if (word === 'my_function') {
        return new vscode.Hover({
          contents: [
            '**My Function**',
            'This function does something special.',
            '```python',
            'def my_function(arg1, arg2):',
            '  # Function implementation',
            '  return result',
            '```'
          ]
        });
      }

      return undefined;
    }
  });

  context.subscriptions.push(disposable);
}

export function deactivate() {}
登录后复制

这个例子展示了如何为特定的单词(例如

my_variable
登录后复制
my_function
登录后复制
)提供自定义的悬停提示。你可以根据需要修改这个例子,使其能够根据你的语言和代码结构提供更复杂的信息。

语言服务器协议(LSP)

如果你需要更高级的功能,例如自动完成、代码诊断等,那么你需要使用语言服务器协议(LSP)。LSP允许你创建一个独立的语言服务器,它负责分析代码并提供各种语言特性。VSCode通过LSP与语言服务器通信,从而实现对各种语言的支持。

使用LSP需要更多的编程工作,但它可以提供更强大的功能和更好的性能。你可以使用现有的LSP库,例如

vscode-languageserver
登录后复制
,来简化开发过程。

LSP的优势在于,你只需要实现一次语言服务器,就可以在多个编辑器中使用它。这可以大大减少开发工作量,并提高代码质量。

如何让悬停提示显示更丰富的信息?

百灵大模型
百灵大模型

蚂蚁集团自研的多模态AI大模型系列

百灵大模型 313
查看详情 百灵大模型

你可以使用Markdown语法来格式化悬停提示的内容。例如,你可以使用

**
登录后复制
来加粗文本,使用
*
登录后复制
来斜体文本,使用
\
登录后复制
```来插入代码块。

return new vscode.Hover({
  contents: [
    '**My Function**',
    'This function does something special.',
    '```python',
    'def my_function(arg1, arg2):',
    '  # Function implementation',
    '  return result',
    '```'
  ]
});
登录后复制

此外,你还可以使用

vscode.MarkdownString
登录后复制
类来创建更复杂的Markdown内容。例如,你可以使用它来插入链接、图片等。

如何动态生成悬停提示的内容?

你可以根据代码的上下文来动态生成悬停提示的内容。例如,你可以根据变量的类型、函数的参数等信息来生成不同的提示。

provideHover(document, position, token) {
  const word = document.document.getText(document.getWordRangeAtPosition(position));
  const line = document.getText(new vscode.Range(position.line, 0, position.line, position.character));

  if (line.includes("my_object.")) {
    return new vscode.Hover(`This is a property of my_object`);
  }

  return undefined;
}
登录后复制

这需要你对代码进行解析,并提取相关的信息。你可以使用现有的代码解析库,例如

acorn
登录后复制
,来简化解析过程。

如何调试VSCode扩展?

VSCode提供了强大的调试功能,可以帮助你调试扩展。你可以在VSCode中设置断点,并逐步执行代码。你还可以使用

console.log
登录后复制
来输出调试信息。

要调试扩展,你需要创建一个launch configuration。在VSCode的

launch.json
登录后复制
文件中,你需要添加一个配置,指定要调试的扩展。

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "extensionHost",
      "request": "launch",
      "name": "Launch Extension",
      "runtimeExecutable": "${execPath}",
      "args": [
        "--extensionDevelopmentPath=${workspaceFolder}"
      ],
      "outFiles": [
        "${workspaceFolder}/out/**/*.js"
      ],
      "preLaunchTask": "npm: compile"
    }
  ]
}
登录后复制

然后,你可以按下F5键来启动调试。VSCode会自动启动一个新的VSCode实例,并在其中加载你的扩展。你可以在这个新的VSCode实例中测试你的扩展,并查看调试信息。

以上就是如何为VSCode添加自定义悬停提示和文档显示?的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号