Python Perl 的等价文档 "perldoc"
Python documentation equivalent for Perl's "perldoc"
快速 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.
Python 文档字符串存储在 doc 变量中。您可以查看该变量以获取信息:
print( int().__doc__)
Returns 以下内容:
int(x[ base]) -> 整数
如果可能,将字符串或数字转换为整数。一个浮点数
参数将被截断为零(这不包括字符串
浮点数的表示!)转换字符串时,使用
可选的基地。转换 a 时提供基数是错误的
非字符串。如果 base 为零,则根据
字符串内容。如果参数超出整数范围 a
将返回长对象。
安装并使用 IPython。它允许您键入 <object>?
并获取有关该对象的信息。您还可以键入 .
+TAB
来获取对象的属性。 IPython 还有很多很多精彩的功能,我强烈推荐你去看看。
事实证明 pydoc
确实像 perldoc
一样工作!
有一个问题......你只需要输入一些不同的东西!
python -m pydoc <module_name>
还有一点 "haquery"... :)
创建一个 pydoc.bat 文件,如下所示。
pydoc.bat:
python -m pydoc %1
然后将此文件存储在 "C:\Python27"(或与 python.exe 文件相同的位置)
Then swiftly wave your hands over the keyboard and exclaim "SIM SALA BIM!"
您的 pydoc
命令现在可以使用了!
pydoc <module_name>
快速 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.
Python 文档字符串存储在 doc 变量中。您可以查看该变量以获取信息:
print( int().__doc__)
Returns 以下内容: int(x[ base]) -> 整数
如果可能,将字符串或数字转换为整数。一个浮点数 参数将被截断为零(这不包括字符串 浮点数的表示!)转换字符串时,使用 可选的基地。转换 a 时提供基数是错误的 非字符串。如果 base 为零,则根据 字符串内容。如果参数超出整数范围 a 将返回长对象。
安装并使用 IPython。它允许您键入 <object>?
并获取有关该对象的信息。您还可以键入 .
+TAB
来获取对象的属性。 IPython 还有很多很多精彩的功能,我强烈推荐你去看看。
事实证明 pydoc
确实像 perldoc
一样工作!
有一个问题......你只需要输入一些不同的东西!
python -m pydoc <module_name>
还有一点 "haquery"... :)
创建一个 pydoc.bat 文件,如下所示。
pydoc.bat:
python -m pydoc %1
然后将此文件存储在 "C:\Python27"(或与 python.exe 文件相同的位置)
Then swiftly wave your hands over the keyboard and exclaim "SIM SALA BIM!"
您的 pydoc
命令现在可以使用了!
pydoc <module_name>