帮助

您可以使用 Help 窗格来查找、呈现和显示具有文档字符串的任何对象的丰富文档,包括模块、类、函数和方法。这使您可以直接从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 模式显示不带格式的文档字符串,而 Show Source 显示与选定对象的代码或其任何Python部分(如果对象不是纯Python)的代码内联的文档字符串。当文档字符串不可用或不足以记录对象时,后者可能很有用。

Spyder help pane showing different modes

通过悬停获得帮助

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

Editor pane showing help of an object from hover

控制自动导入

当你在那里得到帮助的时候 IPython Console 对于以前未导入的对象,它会自动加载到Spyder自己的内部解释器中,以便在文档可用时显示。这可以在中禁用 Help 窗格右上角的选项菜单,以便仅显示来自导入对象的文档。