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