基礎・上級問題チェック

関数のドキュメンテーション文字列とアノテーションについて、正しいものはどれか。

関数のドキュメンテーションは以下の記述で表す。

def job():
    # job is a function
    pass

インタープリタでドキュメンテーションを参照する場合は、man()関数を使う。

デフォルト値付き引数のアノテーションは以下の記述で表す。

def job(kwarg: str = 'kwarg'):
    pass

返り値のアノテーションは以下の記述で表す。

def job(arg) = str:
    return arg

解説

選択肢3が正解です。

【選択肢1】
関数のドキュメンテーション文字列は「# コメント」ではなく、「''' 〜 '''」で記述します。

【選択肢2】
man()関数ではなくhelp()関数を使います。

【選択肢3】
デフォルト値付き引数のアノテーションの正しい使い方です。

【選択肢4】
返り値のアノテーションは「=」ではなく「->」で記述します。

なお、アノテーションとは型ヒントのことを指します。Pythonは、変数に対してintやstrなどの型を限定するための標準的な構文がありませんが、アノテーションを記述すると、外部モジュールや外部ツールを使って、型のチェックができるようになります。

（公式書籍 p.40-41）