Python文档,相当于Perl';s";perldoc“; 快速概述:

Python文档,相当于Perl';s";perldoc“; 快速概述:,python,documentation,pydoc,Python,Documentation,Pydoc,编写Perl模块时,可以使用样式文档对其进行文档化。然后,要了解该模块的工作原理,只需在命令行中键入以下内容: perldoc 如何使用Python实现这一点? 我知道Python有一种使用“docstrings”记录代码的标准形式,这种形式有点类似于Perl的POD风格。然后可以使用help()函数提取有关Python模块的信息,但这远远不够优雅 首先需要启动Python解释器,然后导入要获取帮助的模块,最后可以使用help()函数获取有关模块的信息 示例: >python # Pri

编写Perl模块时,可以使用样式文档对其进行文档化。然后,要了解该模块的工作原理,只需在命令行中键入以下内容:

perldoc


如何使用Python实现这一点? 我知道Python有一种使用“docstrings”记录代码的标准形式,这种形式有点类似于Perl的POD风格。然后可以使用
help()
函数提取有关Python模块的信息,但这远远不够优雅

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

示例:

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

Python文档字符串存储在doc变量中。您可以查看该变量以了解以下信息:
print(int()。\uuuuu doc\uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu

返回以下内容: int(x[,基])->整数

如果可能,将字符串或数字转换为整数。浮点数 参数将被截断为零(这不包括字符串 表示浮点数!)转换字符串时,请使用 可选的基础。转换数据时提供基是错误的 非字符串。如果基数为零,则根据 字符串内容。如果参数超出整数范围a 将返回长对象。

安装并使用。它允许您键入
并获取有关该对象的信息。您还可以键入
+
选项卡
,以获取对象的属性。IPython还有很多更精彩的功能,我强烈推荐你去看看

事实证明,
pydoc
实际上就像
perldoc
一样工作! 带着一个陷阱。。。你只需要键入一点不同的内容

python-mpydoc


再加上一点“haquery”…) 创建一个pydoc.bat文件,如下所示

pydoc.bat:

python -m pydoc %1
然后将此文件存储在“C:\Python27”中(或与python.exe文件位于同一位置)

然后在键盘上快速挥动双手,大声喊道“SIM SALA BIM!

您的
pydoc
命令现在可以工作了


pydoc

我理解这一点,但这仍然不是很漂亮或有效。您仍然需要在Python解释器内部才能使用它,而且对于任何不熟悉Python的人来说,这种格式都是可怕的。我想告诉一个以前从未使用过Python的用户键入windows cmd提示符,并让它提供有关如何使用所需模块的文档
perldoc
对于Perl来说做得很好
pydoc
是要使用的命令。如果没有,Python安装可能有问题;它们都从请求的对象中提取文档(
pydoc
通过定义和docstring,
perldoc
通过嵌入式
pod
文档)。例如:pydoc3 pathlib.Path
python -m pydoc %1