以前我们使用 # 来我们的代码添加注释，只使用单行注释。

我们定义了一个好函数，函数的描述等信息也应该让调用者很容易获取到，这个时候就用到文档注释。

文档注释将来可以直接生成 api 文档方便阅读。

如果要给函数添加文档注释，直接在函数内部的首行放置一个字符串即可。字符串可以是单行的(" "或者' ')，也可以是是多行的(""" """ 或 ''' ''')。

但是一般使用多行字符串来定义

作为国际惯例：

1. 注释的第一行，一般是对函数的简述。

2. 然后一个空行。

3. 然后开始进行详细描述函数功能等。

def foo(x):
    """该函数是对参数做一些计算

    计算参数的多个次幂

    :param x:  要计算次幂的数字
    :return:  返回2次幂、3次幂、4次幂组成的元组
    """
    return x ** 2, x ** 3, x ** 4

print(foo.__doc__)  # 打印函数的文档注释