最全Pycharm教程(25)——Pycharm编辑器功能之查看帮助文档
1、准备工作
(1)Pycharm版本号为2.7或者更高
(2)与product documentation的注意事项保持一致
(3)已经创建了一个project而且至少向当中加入了两个脚本文件,详见Getting Started
2、高速查看定义
当你仅仅是想知道相关的声明信息时,最好还是使用Quick definition,而无需跳转到实际的定义位置。
比如。将光标定位在一个表达式上。然后在主菜单中选择View→Quick Definition:

你能够在弹出的窗体中看到相关的高速定义信息。然后通过方向键来移动浏览整个提示信息。
单击
button,在Find
tool window窗体中找到高速定义信息:

3、高速查看帮助文档
快捷(帮助)文档显示了当前符号的文档凝视以及相关凝视符。
我们再次将光标定位在某个表达式上。这次我们使用View→Quick Documentation的菜单命令。

在弹出的窗体中我们相同能够通过左右方向键来浏览这个文档信息:

当然我们能够调整弹出窗体的大小。
单击
弹出尺寸调节滚动栏,拖动滑块来改变当前尺寸:

单击
button,在Documentation
tool window窗体中打开高速帮助文档:

单击
恢复到原来的窗体形式。
4、查看外部文档
这个命令同意你通过默认浏览器查看具体帮助文档信息:

顺便提一句。你能够通过quick documentation pop-up window来打开外部帮助文档,能够单击
或者按下Shift+F1快捷键。
外部文档用到的PyQt4。PySide。gtk,wx,numpy,scipy,和kivy等第三方库都是默认版本号的,假设你想查看其他版本号下的帮助文档,比如Pyramid,请到 Python External Documentation相应位置參考。
5、浏览參数信息
这个命令能够显示函数方法的形參信息:

6、浏览环境上下文信息
最后。你能够通过弹出窗体来浏览代码块開始部分的特定的符号信息。
举个样例,我们将光标定位在一个exception上,而函数的声明位于当前可视编辑范围之外。然后按下Alt+Q或者View→Context Info菜单命令:

浙公网安备 33010602011771号