クラスの docstring
クラスの docstring に書く内容として、PEP 257 の考え方に沿った最も適切なものを1つ選べ。
- A
クラスの内部の実装の詳細だけを、すべて書く。
- B
docstring は、クラスには書いてはならない。
- C
クラスの名前を、そのまま繰り返す。
- D
クラスの目的と、公開するメソッドや属性の要約。必要なら、使い方の例。
正解と解説を見る
正解:D
クラスの docstring は、目的、公開するメソッドと属性、使い方を簡潔に書く。__init__ の引数は、クラスの docstring か __init__ の docstring に書く。
| 項目 | 規則 |
|---|---|
| 書く対象 | 公開するモジュール・関数・クラス・メソッド |
| 書き方 | 三重の二重引用符(""")。1行目に要約を書く |
| 複数行 | 要約の後に空行を入れ、閉じの """ は単独の行に置く |
| モジュールのdocstring | ファイルの先頭に置く(importより前) |
| 文体 | 1行目は命令形で、ピリオドで終える(「〜を返す」など) |
| バックスラッシュを含む場合 | raw文字列(r""")にする |
- A
誤り。利用者向けの説明が中心。
- B
誤り。書く。
- C
誤り。新しい情報がない。
- D
正しい。利用者が、使い方を知るための説明。
このサイトの問題は、各試験の公式に示された出題範囲に沿って作ったオリジナルの模擬問題です。本試験の問題ではありません。一般社団法人Pythonエンジニア育成推進協会の公式サービスではありません。