首页 > > 网络编程 > 其它 >

Python的函数文档

2018-08-17 09:47:10来源：博客园阅读 ()

在函数内部的第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__属性来查看函数文档，结果更为简洁。

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有