Pydoc模块做些什么？

Question

对编程和python完全陌生。在我正在学习的这本书中，作者建议我了解Pydoc的用途。

我在谷歌上搜索了一下，找到了一个匹配的(来自Gnome终端)，但它对我来说没有多大意义。有人介意简化一下吗？

Answer 1

Pydoc是Python的帮助/文档模块。

在您的Windows终端上使用此命令来了解python中的函数的作用：

python -m pydoc <function>

例如：

python -m pydoc raw_input

如果某个函数的文档很长，可以使用'q‘来去掉它。

例如，在

python -m pydoc Tkinter

Answer 2

这是一个生成python样式文档的工具，请参阅http://docs.python.org/2/library/pydoc.html

你可能也想看看Sphinx。

Answer 3

Python中的Pydoc模块可用于生成html页面形式的文档，甚至可以在控制台上生成文档

python -m pydoc 

这个命令提供了一些选项，比如查看文件的pydoc，-k搜索不同的库，-p允许在web浏览器中打开一个页面来查看python包，-g提供了一个查看文档的图形界面，-w编写了一个html输出。以下是可用于测试的示例命令。

python -m pydoc yourpythonfile
python -m pydoc -k ftplib
python -m pydoc -p 314
python -m pydoc -w file

我已经在目录file1.py和file2.py中创建了两个示例文件，其中只有一行注释的简单代码。

def f2m(ft):
    """ Return the number of meters eq to feet """
    return 0.30 * ft

查看文件注释的一种方法是在同一个文件中简单地编写下面的代码，然后运行python file.py，它就会显示注释。

help(f2m)

查看这一点的另一种方法是编写命令

python -m pydoc file1

查看html页面中注释的另一种方法是键入以下命令并将其导出为html

python -m pydoc -w <dir>

如果您有多个python文件，并且希望在单独的文件夹中生成HTML，那么简单的shell命令就可以完成这项工作。下面的代码生成一个文件夹'htmldocs‘，然后生成html并将它们移动到这个新文件夹中。如果你在右上角打开任何一个页面，你可以看到索引选项，通过它你可以浏览其他页面。

mkdir -p htmldocs
pydoc -w `find . -name '*.py'`
mv *.html htmldocs