VSCode中Python dataclass实例鼠标悬停如何显示类文档？

方法1：调整Pylance语言服务器设置 #

VSCode默认使用Pylance作为Python语言服务提供商，修改以下设置即可让实例悬停时展示类文档：

• 打开VSCode设置（快捷键Ctrl+,）
• 搜索Python > Analysis: Type Checking Mode，将其设置为basic或更高等级（如strict）
• 搜索Python > Analysis: Show Docstring，确保该选项处于勾选状态

方法2：给实例添加显式类型注解 #

通过标注实例的具体类型，让Pylance精准识别并关联类的文档：

from dataclasses import dataclass

@dataclass
class NameAge:
    """
    存储姓名与年龄的数据类
    示例:
        NameAge(name="张三", age=25)
    """
    name: str
    age: int

# 显式标注实例类型
name_age_obj: NameAge = NameAge("张三", 25)

此时悬停name_age_obj就能看到NameAge类的完整docstring。

方法3：使用类型提示注释（兼容旧代码） #

如果不想修改代码结构，也可以通过注释为实例补充类型信息：

name_age_obj = NameAge("张三", 25)  # type: NameAge

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