36.函数的文档说明

>>> def test(a,b):
...     "用来完成对2个数求和"
...     print("%d"%(a+b))
... 
>>> 
>>> test(11,22)
33

如果执行，以下代码

>>> help(test)

能够看到test函数的相关说明

Help on function test in module __main__:

test(a, b)
    用来完成对2个数求和
(END)

例子1：

# 定义一个变量 他是做什么的
# 注释: 解释说明代码
# a = 10

# 函数的文档说明: 解释说明函数的

# 定义一个函数
def add2num(a, b):
    """
    这个函数的作用是求和
    :param a: 数字1
    :param b: 数字2
    :return: 没有返回值
    """
    # 求和
    ret = a + b
    print(ret)

# # 函数的调用

add2num(10, 20)

# 查看文档说明
# 方式1: help函数
help(add2num)
# 方式2: 把光标放在函数调用的上面 按ctrl + q

运行结果：

30
Help on function add2num in module __main__:

add2num(a, b)
    这个函数的作用是求和
    :param a: 数字1
    :param b: 数字2
    :return: 没有返回值