Python 入門コース / 第4章 関数（第25〜32回） / レッスン 31

docstring と型ヒント

docstring で説明を残す

関数の先頭に書いた文字列は docstring として扱われ、help() やエディタのポップアップに表示されます。コメントと違い、プログラムから読み出せる説明です。

型ヒントで意図を示す

def add(a: int, b: int) -> int: のように、引数と戻り値の型を書けます。実行時にチェックはされません（違う型を渡しても動いてしまう）。効果は、エディタの補完・警告と、読み手への説明です。

厳密に検査したいときは mypy のような外部ツールを使います。まずは「関数の境界（引数・戻り値）に書く、中身は推論に任せる」で十分です。docstring と型ヒントは、3 か月後の自分に向けたメモだと思ってください。