95. python如何生成代码文档

python有一个内置的模块可以生成和查看代码文档,他是pydoc,例如我们要查看sys模块的文档,可以通过以下命令:

python -m pydoc sys

-m是运行一个库模块作为脚本。这里是运行pydoc模块。sys是传递给pydoc模块的参数,表示查看sys模块的文档。

pydoc就如起字面含义,是python文档工具。例如我们来查看id函数的含义:

python -m pydoc id
Help on built-in function id in module builtins:

id(obj, /)
        Return the identity of an object.

        This is guaranteed to be unique among simultaneously existing objects.
        (CPython uses the object's memory address.)

运行”python -m pydoc <name>”显示关于<name>的文档。 <name>是函数名,模块或者包。或者源文件。

运行”python -m pydoc -w <name>”将模块的HTML文档写到名为“<name>.html”的文件中。模块的文档此前已经通过文档字符串 写在源代码文件中,这时就可以独立输出到html文件中。