使用 Python 中的 pydoc 模块生成文档

简介

pydoc 模块会自动从 Python 模块生成文档。文档可以保存为控制台上的文本页面，显示在 Web 浏览器上，甚至可以保存为 HTML 文件。

在本文中，您将学习在各种情况下查看这些文档的方法，甚至了解有助于您为 Python 脚本创建自己的文档的文档字符串。

现在您已经了解了 pydoc 的用途，让我们开始吧。

入门

pydoc 模块与 Python 一起打包，这意味着您无需单独下载和安装它。

要访问 pydoc，您必须首先导入它。

import pydoc

使用 help() 函数访问交互式 Shell

您可以使用 pydoc 的 help 函数访问 pydoc 中的交互式 Shell。

为此，启动您的终端并进入 Python 交互式 Shell。

现在，导入 pydoc，然后使用 pydoc.help() 命令启动交互式 Shell。

示例

>>>import pydoc
>>>pydoc.help()

现在，您可以输入模块、数据类型、函数、类等名称，以直接从交互式脚本获取其文档。

从浏览器查看文档

如果您想从浏览器查看文档，可以使用 pydoc 很容易地做到这一点。

这次，您无需通过 Python Shell 运行命令。相反，您可以为它提供参数并直接启动它。

为此，启动您的终端并键入以下命令。

python −m pydoc −b

这应该会在浏览器上生成您本地系统上所有 Python 模块、函数和对象的文档。

您甚至可以通过这种方式搜索和检索特定关键字。

C:\Users\vijay>python −m pydoc −b
Server ready at https://:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

使用文档字符串

示例

def documentation():
   '''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)

输出

Documentation using docstrings
Help on function documentation in module __main__:

documentation()
Documentation using docstrings

结论

您现在知道如何使用 pydoc 函数离线查看和阅读各种 Python 关键字、函数、模块和方法的文档。

您还学习了如何使用文档字符串生成和创建自己的文档。

在大型项目中工作时，维护良好的文档至关重要，以便了解您在何处做什么，并在将来避免混淆。它还有助于防止各种未知或运行时错误。

S Vijay Balaji

更新于：2021 年 2 月 11 日

7K+ 次浏览

开启您的 职业生涯

通过完成课程获得认证

开始