ITエンジニアには、プログラマーというプログラミングを行う仕事を行います。
プログラム言語はコーディングしたロジックで動作しますが、コメントとしてソース内にメモを残すことができます。
コメントは、コーディングする人が単純にメモとして処理の内容を記載したり、開発者の覚書として他の人がソースコードを見たときにコメントを見るだけで分かりやすくするために使われます。
コメントには日本語を使うことができますので、有益な内容からユニークなものまであります。
この記事では、ITエンジニアの私が現場で見たコメント集を10選紹介します。
プログラミングのコメント集10選
疑問
// なぜか同じ処理を2回やっている
コードを最初に書いた人ではなく、書かれたコードを読んで人が理解できないときに書かかれます。
なんで同じ処理を2回もやっているの？
というような明らかに処理がおかしくてコードレビューの指摘漏れを嘆くものや
なんでこれで動いているの？
といった読んだ人が理解不能できない場合に残されるコメントになります。
注意
// とりあえずこれで動くので消さないこと
コードを読んだ人への注意として書かれます。
コードを読んだ人が消してしまうと動かなくなってしまうので気を付けて！という意図で残されたりします。
ただ、この例のコメントでとりあえず動くという趣旨のコメントは実装者が何で動いているか理解しないで実装しているケースがあるので、実装者よりもスキルが高いエンジニアの場合はリファクタリングとして消しても動くようにしてしまったりすることもあります。
不満
// ここは共通化してください
コードを読んだ人が書いた人への不満が記述されているのを見ることがあります。
コードレビューをして残したコメントかもしれないですが、GitHubやBitbucketではレビュー指摘をWebブラウザから残せる機能がありますので、直接コードに書いてほしくないですね。
こういった不満も余裕があるプロジェクトであればリファクタリングで修正されることがありますので、メモとして残してあるだけで良いことではあります。
言い訳
// 時間がなかったのでこうするしかなかった
明らかなクソコードが埋め込まれている場合、大抵の場合はプロジェクトの納期が少なかったり、炎上プロジェクトで緊急で修正された場合が多く、コーディングした人の言い訳がコメントに残されていることも。
怒り
// 酷すぎる。。こんなクソコード残すな！
コードを読んで人が書いた人に対して残した怒りのコメントです。
このコメントが残されている場合は、言い訳と同じで切羽詰まっていて汚いコードになってしまったこともありますが、コーディングスキルが低いエンジニアや経験の浅い駆け出しエンジニアによって書かれた場合が多いです。
クソコードと豪語するぐらいですから、コードを読んだ人の方が書く人よりもスキルが高いことにはなると思います。
嘘
// データ取得処理
例のようなコメントが書いてあったらデータ取得処理だと思いますよね？
それでデータ削除処理が書いてあったときは凍りました…。例えばこの処理を参考に新しいデータ取得処理を作ろうとしたのに動かしてみたら削除されてしまうのですから危険すぎる罠になります。
こういった場合は、コメントを正しい内容に修正してあげた方が他のソースコードを読む人のためにも良いでしょう。
賞賛
// 素晴らしい！天才しか書けないコード
不満や怒りのコメントとは逆で、コードを読んだ人がコードを書いた人を賞賛するコメントになります。
滅多にこのようなコメントは見たことはないですが、見ているこっちもいい気持ちになりますし、本当に凄いコードだと勉強になって良いですね。
TODO
// TODO：後で消す
コードを書いた人によって後で修正する、後で消す、といった備忘として残されたコメントです。
行けたら行く
と言って実際は
行けない
という性格の人が残すと最悪です。
後で消すといって消していないで本番稼働しているプログラミング言語も珍しくないのですから。
呟き
// 今日は定時に帰りたい
コードを書いた人の心の声が反映された呟きのコメントになります。
X（旧:Twtter）のポストと同じような感覚でやっている人もいて、上記のコメントが勤怠入力システムの残業処理のところに書いてあって、そのときは思わず爆笑してしまいました。
謎
// この世界は狂っているんだぜ、へっへっへっ
意味の分からないコメントが残されていることがあります。
ドラクエの復活の呪文のようなコメントが残されていたこともありましたが、プロジェクトメンバーにしか分からない暗号だったのか？
ただの文字化けだったのか？
それともコーディングした人のメンタルが壊れて書かれたものなのか？
まとめ
この記事では、ITエンジニアの私が現場で見たコメント集を10選紹介しました。
私自身はプログラミングでコメントを残すときは、単純に処理の内容やTODOをメモとして残すぐらいなので、呟きや言い訳のコメントは残すことはしないですね。
コードを読んでも不満や怒りを記述することもないので、そのようなコメントを残す人は感情表現が豊かでユーモアのある人なんだと勝手に思っています。
疑問や不満のコメントを残す人は、スキルの高い人である印象があります。
スキルがないと疑問も不満も書けないわけですから。
世界中で動いているプログラミング言語の中には他にも数多の感情のコメントをうごめているんだと思います。
