VS Code Jupyter Notebook中函数悬停无法显示Docstring的解决方法

确保自定义函数的Docstring格式规范 #

Jupyter Notebook的智能提示对标准格式的Docstring支持更稳定，比如Google风格、NumPy风格或reStructuredText。示例如下：

def calculate_area(radius):
    """计算圆形的面积

    Args:
        radius (float): 圆的半径

    Returns:
        float: 计算得出的圆面积
    """
    import math
    return math.pi * radius ** 2

刷新内核并重新导入函数 #

• 关闭当前Jupyter Notebook的内核，重新启动
• 若之前导入过模块，避免缓存影响，可使用以下方式重新加载：

  import importlib
  import 你的模块名
  importlib.reload(你的模块名)
  

调整VS Code相关设置 #

打开VS Code设置，搜索并确认以下选项：

• 勾选Python › Intelli Sense: Enable，确保智能提示启用
• 勾选Jupyter › Intelli Sense: Enable，开启Jupyter环境的智能提示
• 在Python › Analysis: Extra Paths中添加自定义函数所在的文件夹路径，让Python分析器能识别到目标模块

清除VS Code Python缓存 #

• 打开命令面板（Ctrl+Shift+P / Cmd+Shift+P）
• 输入Python: Clear Cache and Reload Window并执行，等待窗口重新加载后再测试

确认Python解释器一致性 #

确保Jupyter Notebook使用的Python解释器和普通编辑器完全一致：

• 点击VS Code左下角的Python版本标识，查看当前Jupyter关联的解释器
• 若与普通编辑器的解释器不同，切换到同一解释器后重新导入函数

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