Python 模擬試験

PythonZen & PEP 8 模擬試験 第3回 問15・PEP 8 コメントとdocstring（docstring）

docstring の文体

PEP 257 が推奨する、1 行の docstring の書き方として、最も適切なものを1つ選べ。

  1. A

    関数の引数を、すべて羅列した文にする。

  2. B

    関数の名前を、そのまま繰り返す。

  3. C

    関数の動作を命令形で、ピリオドで終わる 1 つの文で書く（たとえば「Return the sum of a and b.」）。

  4. D

    docstring は、できるだけ長く書く。

正解と解説を見る

正解：C

1 行の docstring は、動作を命令形（Return ...、Compute ...）で簡潔に書く。詳細は複数行の docstring に分ける。

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

学習のポイント：「説明する」文体（Returns ...）ではなく、命令形が推奨される。

この問題を演習で解く →

問題一覧へ

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