快速 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.
pydoc
是要使用的命令。如果缺少该命令,则可能存在Python安装问题。 - chepnerperldoc
一样工作? - tjwrona1992pydoc
通过定义和文档字符串,perldoc
通过嵌入的pod
文档)。 - chepner