4.1 Python関数の説明ドキュメントと関数ドキュメントの表示

1293 ワード

1、関数の説明ドキュメントを提供し、関数ドキュメントを表示する

関数の説明文書を提供する

def test(parm1,parm2):
    '''
    test      
    parm1 -   ...
    parm2 -   ...
    return -   ...
    '''
    pass

関数ドキュメントの表示

方法1

print(test.__doc__)

    test      
    parm1 -   ...
    parm2 -   ...
    return -   ...

方法2

print(help(test))

Help on function test in module __main__:

test(parm1, parm2)
    test      
    parm1 -   ...
    parm2 -   ...
    return -   ...