如何在VS Code中鼠标悬停方法时显示含@param的完整信息

要让VS Code鼠标悬停方法时显示@param这类完整的文档信息，核心是确保语言服务能解析注释内容，同时调整悬停框的显示限制，具体操作如下：

• 先确保代码注释规范
  VS Code的悬停信息完全依赖代码里的结构化注释（比如JSDoc、Python docstring等），如果注释不规范，语言服务没法提取@param内容。举个JSDoc的例子：

  /**
   * 计算两个数值的和
   * @param {number} num1 - 第一个待相加的数值
   * @param {number} num2 - 第二个待相加的数值
   * @returns {number} 两个数值的求和结果
   */
  function sum(num1, num2) {
    return num1 + num2;
  }
  

  其他语言同理，比如Python用Google风格或NumPy风格的docstring，Java用Javadoc。

• 调整VS Code悬停相关设置
  打开设置面板（快捷键Ctrl/Cmd + ,），搜索并修改以下选项：

  1. editor.hover.maxHeight：默认250px的高度经常会截断内容，建议改成400px或者直接设为null（取消高度限制），让悬停框能展示更多内容。
  2. 针对具体语言的设置：
     • JavaScript/TypeScript：搜索javascript.hover.documentation和typescript.hover.documentation，确保勾选开启；同时打开javascript.suggest.completeJSDocs、typescript.suggest.completeJSDocs，方便自动生成规范的注释结构。
     • Python（需安装Pylance扩展）：搜索python.hover.showParameters设为true，并确保python.analysis.typeCheckingMode不是off——关闭类型检查会导致文档解析不完整。
     • Java（需安装Red Hat的Java扩展）：确认java.hover.enabled和java.documentation.enabled都处于开启状态，确保语言服务能解析Javadoc里的@param。

• 检查并更新语言扩展
  确保你用的是官方推荐的语言扩展：比如JS/TS用VS Code内置的，Python用Pylance，Java用Language Support for Java。这些扩展对结构化注释的解析更完善，能准确提取并展示@param等信息。如果扩展版本较老，建议更新到最新版。

• 重启VS Code（必要时）
  有些设置修改后需要重启编辑器，让语言服务重新加载配置才能生效。

内容的提问来源于stack exchange，提问作者Pedro Leite