Python 入門　ノート　（43）Docstringsとは

Docstringsとは　（関数の説明を関数内に書く）

関数内にDocuments(説明)を記述します。書き方は、

“””で始まり　”””で終わります。間がコメントアウトとして説明になります。

def example_func(param1, param2):
    """Example function with types documented in the docstring.　：初めに中身の説明をします。

    """
    print(param1)
    print(param2)
    return True

example_func.__doc__

print(example_func.__doc__)

と記入して実行すると、結果が

Example function with types documented in the docstring.

Returns:
bool: The return value. True for success, False otherwise.


Documentsの中身になります。

help関数

help関数を実行してみます。

help(example_func)

example_func(param1, param2)
Example function with types documented in the docstring.

Returns:
bool: The return value. True for success, False otherwise.

同じようにDocumentsが出力されます。

＊help関数で読み込んだDocumentsをHTML化して、Web上で見たりできます。