python - 相当于 Perl 的“perldoc”的 Python 文档

Question

快速perldoc概述：

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

perldoc <module_name>

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

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

例子：

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

我想要一个与 Perl 工作方式等效的 Python：

pydoc <module_name>

但是当我尝试这个时，我得到以下输出：

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

score 5 · Accepted Answer

有一个问题......你只需要输入一点不同！

python -m pydoc <module_name>

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

pydoc.bat：

python -m pydoc %1

然后将此文件存储在“C:\Python27”（或与您的 python.exe 文件相同的位置）

然后迅速地在键盘上挥动你的手，大喊“ SIM SALA BIM！ ”

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

pydoc <module_name>

score 0 · Accepted Answer

安装和使用IPython。它允许您键入<object>?和获取有关该对象的信息。您还可以键入.+TAB来获取对象的属性。IPython 还有很多很多很棒的功能，我强烈推荐你去看看。

score -1 · Accepted Answer

Python 文档字符串存储在doc变量中。您可以查看该变量以获取信息： print( int().__doc__)

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

如果可能，将字符串或数字转换为整数。浮点参数将被截断为零（这不包括浮点数的字符串表示形式！）转换字符串时，请使用可选的基数。转换非字符串时提供基数是错误的。如果基数为零，则根据字符串内容猜测正确的基数。如果参数超出整数范围，则会返回一个 long 对象。