Python コメントとdocstringの違い

	用途	場所	実行時/参照
コメント #	コードの補足説明	どこでも	完全に無視参照不可
docstring """ """	関数・クラスの仕様説明	関数・クラス・モジュールの先頭	__doc__として保持 help()などで参照可能

コメントは、備忘録や一時的なコードの無効化（コメントアウト）で使われます。

docstringは、何をするものかを説明する説明書です。関数の使い方、引数の意味、戻り値の説明等を入れます。

コードの動作を説明するメモです。Pythonの実行時には完全に無視されます。

# ユーザー一覧を取得する
users = get_users()
x = x + 1  # カウントを増やす

関数・クラス・モジュールの仕様や使い方を説明する文字列です。実行時にオブジェクトの __doc__ 属性として保持されます。

def add(a, b):
    """2つの数値を足して返す。

    Args:
        a: 1つ目の数値
        b: 2つ目の数値

    Returns:
        aとbの合計
    """
    return a + b

docstringはプログラムから参照できます：

print(add.__doc__)  # docstringの内容が表示される
help(add)           # ドキュメントとして整形して表示される