帮助

你可以使用 Help 窗格,用于查找、呈现和显示具有docstring的任何对象的丰富文档,包括模块、类、函数和方法。这使您可以轻松地直接从Spyder访问文档,而不必中断您的工作流程。

Spyder main window showing getting help for numpy arrays from editor

您也可以从这里访问Spyder的教程,它将指导您完成使用其关键功能的一些基本步骤。

Spyder Help pane showing the link for the Spyder's tutorial

得到帮助

可以通过静态分析中打开的文件来检索帮助 编辑 ,或通过动态检查 IPython控制台 . 您可以通过按可配置的帮助快捷方式手动触发帮助 (Ctrl-I 默认情况下)。

Spyder Editor and Help panes, with the latter displaying documentation for an object selected in the former.

也可以手动将对象的名称输入 Object 窗格顶部的文本框,如果 Console 被选为 Source .

Spyder Help pane, displaying documentation for an object whose name was written in the object text box

可以分别为两个 Editor 以及 Console 在下面 Preferences ‣ Help ‣ Automatic Connections ,并通过右上角的锁定图标动态打开和关闭 Help 窗格。如果启用,只需键入左括号 (( )在函数或方法之后,名称将显示其关联的帮助。

Spyder console and help pane showing automatic help with parenthesis

了解帮助模式

您可以使用“选项”菜单 (Hamburger 图标)的右上角 Help 窗格以切换帮助显示模式。

Rich Text 模式使用 SphinxPlain Text 模式显示docstring而不格式化 Show Source 显示与所选对象或其任何Python部分(如果对象不是纯Python)的代码内联的docstring。当docstring不可用或不足以记录对象时,后者非常有用。

Spyder help pane showing different modes

悬停寻求帮助

您还可以通过将鼠标悬停在对象上来获取对象的摘要帮助 Editor . 单击悬停弹出窗口将打开 Help 窗格。

Editor pane showing help of an object from hover

控制自动导入

当你在 IPython Console 对于以前未导入的对象,它将自动加载到 内部控制台 以便在可用时显示文档。可以在 Help 窗格右上角的“选项”菜单,以便仅显示来自导入对象的文档。