python中自定义函数的说明文档

# help() 该函数用于查看函数或模块用途的详细说明。
# help语法： help([object])

help(len)  #查看len()的帮助信息
# len为python内置函数 -> python已经为该函数创建了文档说明

 

# 很多时候，需要自己创建函数的文档说明,这样也方便读懂自己的代码
# 自定义一个函数
def sum_2(num1, num2):
    return num1 + num2

help(sum_2)        #如果一个自定义函数 没有文档说明，用help 会默认打印出函数上面的注释。
#执行help(sum_2)后，结果：
​​

# 自定义一个函数
def sum_3(num1, num2,num3):
    # 文档说明
    """
    这个函数是用来计算两个数的和的
    :param num1: 数字1
    :param num2: 数字2
    :param num3: 数字3
    :return: 返回值是三个数字相加
    """
    return num1 + num2 + num3

help(sum_3) 
执行help(sum_3)后，结果为：