在Python中,pydoc做什么？

Question

完全是编程和python的新手.在我正在学习的书中,作者建议我找出Pydoc的目的.

我对它进行了谷歌搜索,并找到了一个匹配(来自Gnome Terminal),但对我来说没有多大意义.有人介意简化一下吗？谢谢.

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

Answer 4

Pydoc 是 Python 的文档生成系统。假设您可以使用 Pydoc 标准记录您的函数，然后它可以用于在代码中生成文档。