Python 模擬試験

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

コメントの書きすぎ

次のようなコメントについての考え方として、最も適切なものを1つ選べ。

「x = x + 1 # x に 1 を足す」

  1. A

    コードを読めば分かることを繰り返しているので、不要である。なぜそうするのかが分からない部分に、理由を書く。

  2. B

    すべての行に、このようなコメントを付けるのが望ましい。

  3. C

    コメントは、コードの内容を日本語に翻訳したものを書く。

  4. D

    コメントがあるほど、品質が高い。

正解と解説を見る

正解:A

コメントは、コードから分からないこと(理由、背景、注意点)を書く。コードの繰り返しは、読み手の邪魔になり、コードと食い違ったときに混乱する。

PEP 8 のコメントの規則。
種類規則
ブロックコメント直後のコードと同じ深さで、行頭は「# 」(シャープと空白)
インラインコメントコードの後ろに空白2つ以上を空けて「# 」。控えめに使う
内容コードを言い換えるだけのコメントは書かない。理由や意図を書く。コードと食い違ったら更新する
言語・文読み手が通じる言語で、完全な文で書く
コメントアウトされたコード残さない(バージョン管理を使う)

学習のポイント:コードを読みやすくする(名前・構造)ことで、コメントを減らす。

この問題を演習で解く →

問題一覧へ

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