pydoc是python自带的一个文档生成工具，使用pydoc可以很方便的查看类和方法结构，pydoc模块可以从python代码中获取docstring，然后生成帮助信息。这里紧接着前两篇，介绍一些关于说明文档本身的一些问题

示例文件test.py的内容如下:

# @Time    : 2022/5/3 13:46
# @Author  : ywb
# @Site    : 
# @File    : test.py
# @Software: PyCharm
​
​
# 这是函数上面的单行注释
def func_01():
    """
    这是一个函数
    """
    pass
​
​
# 这是类上面的单行注释
class TestClass(object):
    """
    这是类定义时的注释
    """
​
    # 这是方法前面的注释
    def method_01(self):
        """
        这是类中的一个方法
        """
        pass
​
a = 1
b = 2

1.模块的文档说明

整个文件的说明文档如下:

通过查看文档的方法，我们可以看到在html的文档主要分成四部分：py文件的顶部注释、Classes、Functions、Data

2.函数的说明文档

function上面有#注释时，展示#号的注释

function下有”””多行注释”””时优先展示多行注释，就不展示顶部的#号的注释了

说明文档中func_01的内容如下:

3.类的说明文档

class上面有#注释时，展示#号的注释

class下有”””多行注释”””时优先展示多行注释，就不展示顶部的#号的注释了

说明文档中TestClass的内容如下:

4.方法的说明文档

method上面有#注释时，展示#号的注释

method下有”””多行注释”””时优先展示多行注释，就不展示顶部的#号的注释了

说明文档中method_01的内容如下:

5.data相关的说明文档

这里的data是指的模块下直接定义的变量，不是function或class的变量