問題解説)PEP8で推奨されるコメントの説明について、正しいものを次の選択肢の中から選びなさい。

当コラムでは、PythonZen & PEP 8 検定試験(こちらでオンライン受験できます)で出題されている問題の解説を行なっています。当コラムシリーズを読んで自信がついたら、ぜひ試験に挑戦してみてくださいね。

今回のコラムで解説する試験問題はこちらです。

問題

PEP8で推奨されるコメントの説明について、正しいものを次の選択肢の中から選びなさい。

  1. コメントの種類には、ブロックコメント、インラインコメント、docstring(ドキュメント文字列)がある。
  2. コードを変更したときにコメントとコードの意味が矛盾してしまうのを避けるため、なるべくコメントは書かないようにする。
  3. 分かりやすくするために、コメントは文章よりも単語で書くようにする。
  4. Pythonは世界中の人が使用しているため、コメントは必ず英語で書く。

解答のヒント

PEP 8の「コメント」(Comment)が問題の範囲になっています。

Block comments generally apply to some (or all) code that follows them

ブロックコメントは一般的には、それ以降の数行(あるいは全行)のコードを説明しています

An inline comment is a comment on the same line as a statement.

インラインコメントは、コードのステートメントと同じ行にあるコメントのことです。

Conventions for writing good documentation strings (a.k.a. “docstrings”) are immortalized in PEP 257.

優れたドキュメント文字列(別名「docstring」)を書くための規約がPEP 257でお決まりのものとなっています。

Comments that contradict the code are worse than no comments. Always make a priority of keeping the comments up-to-date when the code changes!

コードの内容と矛盾するコメントは、コメントが全くない状態よりも悪です。コードを変更した場合は、常にコメントを最新の情報に保つことを優先してください!

Comments should be complete sentences. The first word should be capitalized, unless it is an identifier that begins with a lower case letter (never alter the case of identifiers!).

コメントは完全な文章であるべきです。小文字で始まる識別子を除いて、文章の一文字目は大文字にします(識別子の大文字小文字を入れ替えてはいけません!)。

Python coders from non-English speaking countries: please write your comments in English, unless you are 120% sure that the code will never be read by people who don’t speak your language.

英語圏以外の国のPythonコーダーへ:コメントは英語で書くようにしてください。ただし、そのコードがあなたの言語を話さない人に読まれることが絶対にないと120%確信している場合は、英語で書かなくても構いません。

ガイドラインには具体的なサンプルコードも載っていますので、併せて確認しておきましょう。

正解はこちら

ガイドラインには、ルールとして従わなくてはいけないこと(must)、推奨されること(should)、各ルールの適用例・非適用例(cases)が書いてあります。ルールを機械的に覚えるだけではなく、なぜこのルールがあるのかを意識していくと、理解が深まりますね。

自信がついてきたら PythonZen & PEP 8 検定試験 で実際に試験を受けて、正解を当ててみましょう。

そして、みなさんのPython開発にも活かしていただけると嬉しいです。

PAGE TOP