Python基础(二十一): 注释文档 和 导出文档

一、给类添加注释文档

• 格式

class 类名:
    """
    这里是类的注释, 用来描述类的作用, 类的构造函数等等
    Attributes:
        这里写上类的属性注释
    """
    
    def 方法名(self, arg1, arg2...):
        """
        这里注释方法的作用效果
        :param arg1: 参数的含义, 参数的类型, 是否有默认值
        :param arg2: 参数的含义, 参数的类型, 是否有默认值
        :return: 返回的结果的含义, 返回值的类型
        """
        pass
复制代码

• 示例:

class Person:
    """
    这是一个Person类, 用来描述人的信息
    Attributes:
        name: 人的名字, str类型, 默认值是 zhangsan
        age: 人的年龄, int类