Python 注释与文档

注释

• 单行注释定义在#之后
• 多行注释定义在三个单引号'''或三个双引号"""之间

单行注释

# 单行注释
# 单行注释
# 单行注释

多行注释

"""
多行注释
多行注释
"""

文档

说明文档多使用多行注释

文档可以通过__doc__获取

print(模块.__doc__)
print(函数.__doc__)
print(类.__doc__)

---

模块文档

模块文档需要写在模块文件的开头，并且与其间隔一个空行

"""
模块说明
模块说明
"""

# ...
# ...

---

函数文档

函数文档需要写在函数体前面，并且与其间隔一个空行

def 函数(参数1, 参数2):
    """"
    函数说明
    函数说明

    Args:
        参数1 (数据类型): 参数1的说明
        参数2 (数据类型): 参数2的说明

    Returns:
        返回值的数据类型: 返回值的说明
    """"

    # ...
    # ...
    return 返回值

---

类文档

函数文档需要写在类中成员前面，并且与其间隔一个空行

class 类名:
    """"
    类说明
    类说明

    Attrs:
        属性1: 属性1的说明
        属性2: 属性2的说明

    Methods:
        方法1: 方法1的说明
        方法2: 方法2的说明
    """"

    # ...
    # ...