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

夏静酱_8587

夏静酱_8587

2026-08-11

252人浏览

原创

shift+tab是jupyter中最即时的文档查看方式:1次弹出内联文档,2次展开参数类型,3次显示完整docstring摘要,4次打开全屏富文本窗口;func?输出结构化元信息,func??叠加源码展示;help()适合离线或嵌套对象但为纯文本流。

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

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

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

连续按 2 次 Shift+Tab 展开参数类型和简要说明;按 3 次会显示完整 docstring 摘要(含返回值);按 4 次弹出全屏富文本窗口,支持 markdown 渲染、代码高亮和跳转链接(如 pandas 官方 API 页面)。

常见卡点:

  • 没反应?检查是否在编辑模式(不是命令模式),且光标确实在函数名附近
  • 只显示签名没说明?说明该函数 docstring 缺失或格式不规范(比如没写 Parameters 区块)
  • 弹窗太小遮挡代码?鼠标悬停右上角,点 ^ 展开,或点 x 左边按钮新开标签页浏览

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

func? 等价于 %pinfo func,输出结构化元信息:签名、docstring(自动解析 Google/Numpy 格式)、定义文件路径、行号、所属类(如 pandas.core.frame.DataFrame.groupby)。

func?? 在 ? 基础上叠加源码展示——如果源码可访问(非 C 扩展),会自动剥离装饰器包装层,保留原始缩进和注释,关键逻辑高亮显示。

注意点:

Jupyter Notebook 7.5.4
Jupyter Notebook 7.5.4

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

下载
  • ?? 对内置函数(如 len、print)无效,因为它们用 C 实现,没有 Python 源码
  • 自定义函数 docstring 写得越规范(带 Args:、Returns:),? 输出的参数表就越完整
  • np.array? 和 help(np.array) 效果接近,但前者更快、更轻量,后者可能触发冗长的交互式分页

help() 函数适合离线环境或嵌套对象

help(func) 是标准 Python 的文档入口,在 Jupyter 里依然可用,尤其适合:

  • 模块层级查看(如 help(torch.nn))
  • 无法用 ? 解析的对象(比如某些动态生成的类、或符号未绑定时)
  • 想把文档内容赋值给变量做进一步处理(doc = help(os.path.join).__doc__ 不行,但 doc = os.path.join.__doc__ 可以)

缺点是输出为纯文本流,不能折叠/展开,也不支持 markdown 渲染;遇到长文档容易刷屏,建议配合 print(func.__doc__) 截取核心段落。

容易被忽略的细节:文档质量取决于源码本身

Jupyter 能展示什么,完全取决于函数作者写的 docstring 是否完整、格式是否标准。numpy/pandas/scikit-learn 这类主流库通常很规范,但很多第三方包或内部工具函数只有单行注释,甚至为空——这时 ? 和 Shift+Tab 都只能显示签名,没法告诉你参数含义。

遇到这种情况,别硬猜:

  • 先查官方文档网页(func? 弹窗里常带跳转链接)
  • 用 func?? 看源码逻辑,尤其注意默认参数和类型断言
  • 运行 dir(func) 或 func.__code__.co_varnames 获取参数名列表(对闭包/lambda 无效)

真正卡住的时候,往往不是操作不会,而是文档本身没写清楚。

相关文章

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

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

下载

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

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4744

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

28177

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3387

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3387

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2623

5

热门下载

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

精品课程

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