Python 模擬試験

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

クラスの docstring

クラスの docstring に書く内容として、PEP 257 の考え方に沿った最も適切なものを1つ選べ。

  1. A

    クラスの内部の実装の詳細だけを、すべて書く。

  2. B

    docstring は、クラスには書いてはならない。

  3. C

    クラスの名前を、そのまま繰り返す。

  4. D

    クラスの目的と、公開するメソッドや属性の要約。必要なら、使い方の例。

正解と解説を見る

正解:D

クラスの docstring は、目的、公開するメソッドと属性、使い方を簡潔に書く。__init__ の引数は、クラスの docstring か __init__ の docstring に書く。

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

学習のポイント:help(クラス) で、まとめて表示される。

この問題を演習で解く →

問題一覧へ

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