Python函数的文档字符串和__doc__属性

Python函数文档字符串和__doc__属性

def add(a, b):
    a = 123
    """
    1.描述函数功能
    2.参数说明
    3.返回值说明
    """
    ...
    return ...

写在三引号中内容就是我们通常给一个函数写的文档（注释），这个文档是和函数的内置属性__doc__相关的。你可以使用该属性直接查看函数的文档字符串。例如：

print(add.__doc__)

注意：文档字符串必须出现在函数体的最前面，它的前面不能有其它的东西，否则__doc__将无法获取到文档字符串中的内容。也不能有多个文档字符串，如果有多个，那么只有第一个会成为__doc__的内容。
下面的举两个例子来说明：

# 多个文档字符串，只有第一个有效
def func():
    """
    123
    """

    """
    456
    """
    return 123
print(func.__doc__)

打印结果如下所示：

123

---

# 文档字符串之前不能有别的东西
def func():
    a = 123
    """123"""
    return a
print(func.__doc__)

打印结果如下所示：

None