Python 悬停显示注释

复制本地路径 | 在线编辑

根据 DeepSeek 进行修改，花了一些时间，特此记录：链接。

目的：鼠标悬停在某个变量的时候，可以看到变量定义那里的注释。

✅ 方法1：类级别注解 + 文档字符串

class FileProcessor:
    file_cache: Dict[Path, Tuple[float, Path]]
    """文件缓存字典：Key=原始文件路径, Value=(修改时间, 转换后路径)"""

    config: Dict[str, str]
    """配置字典：存储所有运行时配置参数"""

    def __init__(self):
        self.file_cache = {}
        self.config = {}

✅ 方法2：直接在下方使用文档字符串

class FileProcessor:
    def __init__(self):
        self.file_cache: Dict[Path, Tuple[float, Path]] = {}
        """文件缓存字典：Key=原始文件路径, Value=(修改时间, 转换后路径)"""

        self.config = {}
        '''单引号和双引号都可以'''

        self.config2 = {}
        '''
        这种也可以，但是如果是一行最好就用上面的方式
        '''

❌ 无效的方法

class FileProcessor:
    def __init__(self):
        self.file_cache1: Dict[Path, Tuple[float, Path]] = {}  # 这种注释不会显示

        self.file_cache2 = {}
        # 使用井号没有效果

其他说明

1. 如上所示，最好也添加 Dict[Path, Tuple[float, Path]] 这种详细的格式注解

Comments