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