Jupyter Notebook 怎么查看函数说明文档

星伟大大_2921

星伟大大_2921

2026-08-22

172人浏览

原创

shift+tab是最常用、最即时的查看方式,光标停在函数名右侧或括号内按shift+tab弹出内联文档,连续按可切换详细程度,支持四档展开;func?和func??分别显示结构化元信息与源码,help()适合查嵌套属性但格式简陋。

jupyter notebook 怎么查看函数说明文档

Shift+Tab 是最常用、最即时的查看方式

光标停在函数名右侧或括号内(比如 pd.read_csv 后面、或 pd.read_csv(|) 的竖线位置),按 Shift+Tab 就能弹出内联文档窗口。它不依赖执行,也不需要 import 成功——只要符号已加载进当前 namespace,就能响应。

连续按 Shift+Tab 可切换详细程度:第一次显示精简签名(如 read_csv(filepath_or_buffer, sep=',', ...));第二次展开参数类型和简要说明;第三次拉出完整 docstring 摘要(含返回值);第四次全屏打开富文本帮助页(支持 markdown 渲染、代码块高亮、超链接跳转)。

常见卡点:

  • 没反应?确认光标确实在函数名「右侧」或括号「内部」,不在字符串里、注释里、引号中间
  • 只显示 Signature: unknown?该函数可能没绑定到变量(比如写错名、拼写错误、未 import)、或来自 C 扩展模块(如 numpy.ndarray.sum 的部分方法)
  • 文档是英文?右上角有 ^ 按钮可展开,旁边 图标能新开标签页,方便复制到翻译工具

函数名后加 ? 或 ?? 直接看源码级信息

func? 等价于 %pinfo func,输出结构化元信息:签名、解析后的参数表(按 Google/Numpy 格式提取)、定义文件路径、行号、所属类。对 pandas、scikit-learn 这类文档规范的库效果最好。

func??? 基础上叠加源码展示——自动绕过装饰器包装层,高亮核心逻辑,保留原始缩进和注释。但前提是源码可访问(纯 Python 实现的函数才有效;np.array 这类 C 实现会提示 No source found)。

自定义函数要注意:

Jupyter Notebook 7.5.4
Jupyter Notebook 7.5.4

Jupyter Notebook 7.5.4 官方 PyPI wheel 包下载,适合用于本地交互式代码运行、数据分析、教学演示和配置文件实践。

下载
  • 没写 """docstring"""func? 里参数表会为空,只显示签名
  • 写了 docstring 但没用 Args: / Returns: 分段?Jupyter 无法自动解析成表格,仍显示为一段文字
  • 用了 @lru_cache@property?? 会跳过装饰器,直接定位到被包裹的原始函数体

help() 函数适合嵌套对象或临时查漏补缺

help(func) 是标准 Python 内置方式,在 Jupyter 里也能用,但输出格式是纯文本、不可折叠、不支持 markdown 渲染,且必须先 import 成功才能调用。相比 ?Shift+Tab,它更“笨重”,但有个不可替代的场景:查嵌套属性。

比如你想看 pandas.DataFrame.groupby 方法的文档,但 df.groupby? 可能因 df 未定义而报错;这时可以直接 help(pd.core.frame.DataFrame.groupby) ——绕过实例,直击类定义。

性能影响很小,但注意:

  • help() 会触发一次对象 introspection,对大型对象(如未加载完成的 Dataset)可能轻微卡顿
  • 输出中出现 Help on built-in function?说明是 C 实现,源码不可见,只能靠 docstring 理解行为
  • 别写 help(func())(带括号)——那是查返回值的 help,不是查函数本身

容易被忽略的细节:文档来源和更新滞后问题

Jupyter 的文档数据来自运行时环境中的实际对象,不是从官网实时拉取的。这意味着:

  • 你装的是旧版 pandas,pd.read_csv? 显示的就是旧版参数(比如没有 encoding_errors 参数),哪怕官网文档已更新
  • 修改了自定义函数的 docstring 但没重新运行定义单元格?func? 仍显示旧内容
  • 使用 import * 导入时,某些符号可能被覆盖或未正确注入 namespace,导致 Shift+Tab 失效

最稳妥的做法:确保函数已正确定义并执行过,再用 Shift+Tab? 查;怀疑文档陈旧?先 !pip show package_name 确认版本,再比对对应版本的官方文档。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

2026.09.22

0

25

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

20

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

20

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

2026.09.20

40

13

AionClaw AI智能体与电脑自动化任务执行功能使用教程
AionClaw AI智能体与电脑自动化任务执行功能使用教程

AionClaw专题整理AI智能体与电脑自动化相关功能使用教程,涵盖安装部署、AI任务执行、Skills技能、文件处理、浏览器控制、电脑操作、持久记忆、聊天工具连接以及办公、编程和内容创作等功能,帮助用户快速掌握AionClaw的实际使用方法。

2026.09.20

20

15

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

2026.09.16

200

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程