和help()和doc不同，pydoc无需编写任何代码，通过执行pydoc命令即可查看程序的说明文档

以该工程下example_01.py和example_02.py为例子进行叙述，先来看看这2个文件中的内容

example_01.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2021/7/3 22:09
# @Author  : ywb
# @Site    : 反转一个3位整数
# @File    : example_01.py
# @Software: PyCharm
import ddt
​
​
def reverse_three_int_number(num):
    """
    反转一个3位整数
    :param num: 3位整数
    :return: 3位整数反转后的结果
    """
    return int(''.join(list(reversed(str(num)))))
​
​
if __name__ == '__main__':
    print(reverse_three_int_number(123))
    print(reverse_three_int_number(900))

1 在线查看说明文档

执行如下命令，即可通过http://localhost:1234/进行访问说明文档

python -m pydoc -p 1234

注:

-p后面指定了该服务的端口号，这里可以替换成与本地其他服务任意不冲突的端口号即可

一般需要在自己建立的工程目录下使用该命令，否则查看到的则是python环境变量下的模块的说明文档内容

一般有多个python版本时，须指明python版本

web页面部分显示如下:

除了自己建立的工程目录，还有一些python环境变量自带的一些模块，这里不一一列出

其中，example_01.html的内容如下:

2.直接查看某个文件的说明文档

直接去目标文件路径下，在终端执行如下命令即可：

python -m pydoc example_01

result:

3.生成html说明文档

直接去目标文件路径下，在终端执行如下命令即可：

python -m pydoc -w example_01

example_01.html内容如下: