Python文档等效于Perl的"perldoc"

Question

快速perldoc概述:

编写Perl模块时,您可以使用POD样式文档对其进行记录.然后,要了解模块的工作原理,您只需在命令行中输入:

perldoc <module_name>

---

我如何用Python做到这一点？

我知道Python有一种使用"docstrings"记录代码的标准形式,它有点类似于Perl的POD风格.然后可以使用该help()函数提取有关Python模块的信息,但这远非优雅.

首先,您需要启动Python解释器,然后导入您想要获得帮助的模块,最后您可以使用该help()函数获取有关模块的信息.

例:

>python
# Prints Python version info
>>>import <module_name>
>>>help(<module_name>)
# Prints documentation!

---

有没有更好的办法？

我想要一个Python相当于Perl的工作方式:

pydoc <module_name>

但是当我尝试这个时,我得到以下输出:

'pydoc' is not recognized as an internal or external command,
operable program or batch file.

Answer 1

事实证明,pydoc实际上确实有效perldoc!

抓住......你只需要输入一点点不同!

python -m pydoc <module_name>

还有一点点"haquery"...... :)

创建一个pydoc.bat文件,如下所示.

pydoc.bat:

python -m pydoc %1

然后将此文件存储在"C:\ Python27"中(或与python.exe文件位于同一位置)

然后迅速挥动你的手在键盘上,并惊呼" SIM SALA BIM! "

你的pydoc命令现在可以工作了!

pydoc <module_name>