子供の頃に想像していたプログラマーは、
白黒の画面にひたすら英語をダカダカ入力するようなものでした。
しかし実際はもう少しカラフルなエディターでコードを書き、
コードも各所にコメントがあり日英混ざった画面を見て作業をします。
ですが、全て英語で書いてあった方が ” カッコいい ” と思いませんか？
やっぱり日英がごちゃ混ぜだと ” ダサい ” ですよね？
……冗談はさておき、今回は「コメント」の重要性についてです。
コメントを付ける意味
日本人のみならず、英語を普段から使っている人でも、
プログラミング言語は直感的だ！という人は少ないでしょう。
コードには似たような単語が使われがちですし
（特に変数や関数なんかは使いまわすためのものですしね）、
パッと見ただけではどんな処理かが分からないのが普通です。
それを少しでも分かりやすくするために付けるのがコメントです。
普段使っている言葉で処理の概要が書かれていれば、
たとえ難しい書き方をしたコードでも素早く理解できるはずです。
自分自身が忘れないようにメモを残すのはもちろん、
チームでの開発では書いたコードを他のメンバーも見ることになるので、
コードを読みやすくするためのコメントは必要不可欠です。
コメントに書くべき内容
・処理のまとまり毎に概要をコメント
クラス毎、メソッド毎、その中の処理のまとまり毎に、
そこで何をしようとしているのかを書いてあげましょう。
コードの可読性が格段に上がります。
具体的なことは処理を読めば分かるので、
ざっくりと抽象的に書くと良いと思います。
・コードだけでは分からない内容にコメント
一見不用に見えるコードでも、
お客さんの希望や仕様で敢えてそう書いていたり、
データベースのデータや連携している外部システムの都合があったりと、
消したくなるけど消しちゃダメなコードはよくあります。
そういった部分にはなぜ書いてあるのかを書いてあげると安全ですね。
読むのがダルくならないよう、できるだけ端的に。
コメントを書くのはおおよそこの辺りかと思います。
開発や保守をなるだけ円滑・安全に進めるために書いておきましょう。
コメントを書く時の注意点
・書きすぎない
親切に多くを書きすぎるとかえって可読性が下がります。
コード１行１行にコメントを付けたり、
作文かと思うような長文コメントを付けたりするのは避けましょう。
上にも書きましたが、ざっくりと抽象的に書けば十分だと僕は思います。
・嘘を書かない
当たり前だと思うかもしれませんが、
気を付けないと意外とやってしまいがちです。
開発で仕様が二転三転した時や処理を修正した時に
コメント直し忘れるというミスが起こるからです。
動作には問題が無いのでそのまま放置されてしまうと、
可読性を下げるだけのトラップとして機能してしまいます。
コードを直す時にはコメントも丁寧に確認しましょう。
まとめ
上手に扱えばみんなのためになるのがコメントです。
コーディングの腕を磨くのも大事ですが、
適切なコメントを書くセンスも磨いていきたいですね。