VSCode怎么自定义方法重载的悬停说明-VSCode-PHP中文网

VSCode本身不支持自定义方法重载悬停，多签名显示完全依赖语言服务器（如TS Server、Rust Analyzer）返回的重载数据；关键在正确书写TS重载声明或Python typing.overload配合Pylance启用类型检查，而非修改VSCode设置。

vscode怎么自定义方法重载的悬停说明

VSCode 本身不支持“自定义方法重载”的悬停说明——它不解析重载签名，也不提供类似 C# 或 Java 的 overload list 弹窗；你看到的多个签名，全靠语言服务器（如 TypeScript Server、Rust Analyzer）主动返回，编辑器只负责渲染。想让悬停显示多组参数+返回值，关键不是改 VSCode 设置，而是确保语言服务能识别并生成这些重载信息。

为什么悬停里只有一条签名，而不是多个重载？

这不是 hover 被禁用了，是语言服务器压根没推过来重载数据。常见断点：

tsconfig.json 缺失或 "skipLibCheck": true 导致类型库未完整加载（尤其影响 @types/* 中的重载声明）
TypeScript 文件用了 declare function 但没写多个重载声明，只写了实现签名（实现签名不会出现在 hover 中）
JS 文件即使有 JSDoc，也**无法表达重载**：@overload 不是标准 JSDoc 标签，TypeScript Server 忽略它
Python 中 typing.overload 装饰的函数，需配合 Pylance + 启用 python.analysis.typeCheckingMode，否则只显示第一个定义

TypeScript 项目中让重载真正生效的写法

必须用标准的 TS 重载语法：先写多个声明签名，最后写一个实现签名（且实现签名要加 export 或 declare 修饰，否则不被索引）：

// ✅ 正确：hover 会显示全部声明签名
function parse(str: string): number;
function parse(str: string, radix: number): number;
function parse(str: string, radix?: number): number {
  return parseInt(str, radix ?? 10);
}
<p>// ❌ 错误：只有实现签名，hover 只显示这一行
function parse(str: string, radix?: number): number {
return parseInt(str, radix ?? 10);
}</p>

注意：JSDoc 注释必须分别写在每个声明签名上方，不能只写在实现上；/** @param */ 也要按签名一一对应。

Python 重载悬停依赖 `typing.overload` 和 Pylance 配置

Pylance 默认不启用重载解析，需显式开启类型检查：

VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

确保已安装 Pylance（不是基础 Python 扩展）
在 settings.json 中启用："python.analysis.typeCheckingMode": "basic" 或 "strict"
函数必须用 @overload 装饰，且所有重载声明都得是 def（不能是 pass），实现函数单独写且不加装饰器
docstring 只需写在实现函数上，Pylance 会自动合并到各重载签名的 hover 中

示例有效结构：

from typing import overload
<p>@overload
def connect(host: str) -> str: ...</p><p>@overload
def connect(host: str, port: int) -> str: ...</p><p>def connect(host: str, port: int = 8080) -> str:
"""Connect to host.</p><pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">Args:
    host: Hostname or IP
    port: Port number (default 8080)
"""
return f"{host}:{port}"