Python 模擬試験

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

TODO コメント

コードに、あとで対応する作業を示す TODO コメントを書くときの考え方として、最も適切なものを1つ選べ。

  1. A

    何をいつまでに、あるいは、なぜ必要かを具体的に書き、課題管理(チケット)の番号を添えるなどして、追跡できるようにする。

  2. B

    TODO とだけ書いて、内容は書かない。

  3. C

    TODO は、できるだけたくさん書き、放置しておく。

  4. D

    TODO コメントは、コードの品質に関係がないので、書かない方がよい。

正解と解説を見る

正解:A

TODO は、具体的な内容と、必要なら、担当や課題番号を添える。放置された TODO は、定期的に見直す。

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

学習のポイント:FIXME は、既知の不具合を示す。

この問題を演習で解く →

問題一覧へ

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