Python 模擬試験

PythonZen & PEP 8 模擬試験 第4回 問15・PEP 8 コメントとdocstring(docstring)

モジュールの docstring

モジュール全体の説明を書く docstring の位置として、PEP 8 が示すものを1つ選べ。

  1. A

    ファイルの末尾

  2. B

    最初の関数の後ろ

  3. C

    import の後ろで、最初のクラスの前

  4. D

    ファイルの先頭(import より前)

正解と解説を見る

正解:D

モジュールの docstring は、ファイルの先頭(from __future__ 以外の import より前)に書く。__doc__ や help() で参照される。

PEP 8(と PEP 257)の docstring の規則。
項目規則
書く対象公開するモジュール・関数・クラス・メソッド
書き方三重の二重引用符(""")。1行目に要約を書く
複数行要約の後に空行を入れ、閉じの """ は単独の行に置く
モジュールのdocstringファイルの先頭に置く(importより前)
文体1行目は命令形で、ピリオドで終える(「〜を返す」など)
バックスラッシュを含む場合raw文字列(r""")にする

学習のポイント:__all__ や定数は、docstring の後に書く。

この問題を演習で解く →

問題一覧へ

このサイトの問題は、各試験の公式に示された出題範囲に沿って作ったオリジナルの模擬問題です。本試験の問題ではありません。一般社団法人Pythonエンジニア育成推進協会の公式サービスではありません。