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__屬性來查看函數文檔，結果更為簡潔。