Python的函数文档

  在函数内部的第1行开始,使用三引号作为帮助文档的标记字符

def func(name, age, *args):
    '''
    这里是函数的帮助文档
    :param name: 姓名
    :param age: 年龄
    :param args: 其他
    :return: 返回值
    '''
    n = 0
    for item in args:
        print("loop {0}".format(n))
        print(item)
        n += 1

help(func) #使用help方法查看函数文档
print("*"*20)
print(func.__doc__) #使用函数的__doc__属性查看函数文档

 输出为

Help on function func in module __main__:

func(name, age, *args)
    这里是函数的帮助文档
    :param name: 姓名
    :param age: 年龄
    :param args: 其他
    :return: 返回值

********************

    这里是函数的帮助文档
    :param name: 姓名
    :param age: 年龄
    :param args: 其他
    :return: 返回值

从输出可见,使用函数的__doc__属性来查看函数文档,结果更为简洁。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值