プログラムを書くとき、ついコードだけに集中してしまいがちですが、実は「コメント」こそがコードの質を大きく左右する要素の一つなのです。
コメントというのは、プログラムの中に「この処理は何をしているのか」を説明するために書く文章のことです。Pythonなら「＃」、Javaなら「//」などで始まる行がそれにあたります。
コメントの最大の目的は、自分や他人が後からプログラムを読んだときに、理解しやすくすることです。コードは時間が経つほど内容を忘れてしまうものです。たとえ自分で書いたものであっても、数週間後に見返すと、「これ、なんでこう書いたんだっけ？」「これ、どういう意味のコードだったっけ？」となることがよくあります。そんな時に、目的や処理の意図をコメントに残しておけば、すぐに思い出すことができます。
また、プログラミングを使って他の人と共同で何かを製作することがあるかもしれません。チーム開発ではコメントはコミュニケーション手段にもなります。他の人があなたのコードを読むとき、コメントがないと「この変数は何を表しているの？」「この関数はどんな入力を想定しているの？」と迷ってしまいます。そこに分かりやすいコメントがあると、読み手がすぐに全体像をつかめ、バグの修正や機能追加がスムーズに進みます。
ただし、ここで重要なのが「コメントはただ書いたらいいというものではない」ということです。コードを読めばわかるようなことをそのまま説明するのは逆効果です。かえって見にくくなるだけです。
例えば、「i = i + 1 #iを1増やす」といったコメントは不要です。重要なのは、「なぜその処理をするのか」という意図を書くことです。例えば、「# 増加分を1に固定することで、ループ処理を安定させる」といった説明の方が良いです。
さらに、コメントを定期的に見直すことも大切です。コードを修正したのにコメントを更新し忘れると、内容が食い違って逆に混乱を招くことがあります。コードとコメントは常にセットで確認することを意識しましょう。
良いコメントは、いつか見返したときの自分へのメッセージでもあり、チームメンバーへの思いやりでもあります。綺麗なコードよりも、「意図が伝わるコード」を意識する。そのために、コメントは欠かせない存在です。
コメントを残す