関数のドキュメンテーション文字列

2024年6月25日

関数のドキュメンテーション文字列 (docstring) は、Pythonの関数やクラスに関するドキュメントを記述するための特別な文字列です。関数やクラスの定義の直後に記述され、トリプルクォート """ またはシングルクォート ''' で囲まれています。ドキュメンテーション文字列は、関数やクラスの利用方法や機能、引数の説明などを記述するのに使用されます。

ドキュメンテーション文字列は、Pythonの help() 関数やインタラクティブシェルで __doc__ 属性を参照することで、関数やクラスのドキュメントを表示するのに使用されます。

以下は、ドキュメンテーション文字列の例です:

python
def example_function(param1, param2):
    """
    この関数は、引数 param1 と param2 を受け取り、何らかの処理を行います。
    
    Args:
        param1: 何らかの説明を記述します。
        param2: 別の引数の説明を記述します。
    
    Returns:
        戻り値がある場合、その戻り値の説明を記述します。
    """
    # 関数の本体
    pass

この例では、example_function 関数のドキュメンテーション文字列が定義されています。ドキュメンテーション文字列の中には、関数の機能や引数の説明、戻り値の説明などが記述されています。このように、ドキュメンテーション文字列を使うことで、他の人が関数やクラスの使い方や機能を理解しやすくなります。