昔書いたプログラムは“完全に他人”になる｜コメントの重要性をエンジニアとして痛感した話
今日もお疲れ様です。
ちょっとした“あるある話”ですが、よければ軽く読んでいってください。
「……これ、何してるんや？」
コードを開いて、最初に出てきたのがこの一言でした。
きっかけは、プログラムの再調整依頼です。
「ここ、少し仕様変えたいんですが対応できますか？」
そう言われて対象のコードを開いたとき、ふと思い出しました。
——あ、これ自分で作ったやつや。しかも結構複雑なやつ。
……そして数秒後。
「……これ、何してるんや？」
目次
コメントについて
プログラムには、コメントという機能があります。
簡単に言うと、
「ここで何をしているか」をメモとして残しておくようなものです。
プログラムを書いたことがある人なら、最初に触れることが多いと思います。
重要なはずのコメントの扱い
ただ、このコメント。
実際の現場では、つい後回しにされがちです。
正直、コメントがなくても動くものは動きます。
だからこそ、「まあいいか」となってしまうこともあります。
でも、あとからそのプログラムを触るときになると、話が変わります。
コメントがあるだけで、
「ああ、ここはこういうことをしているんだな」と分かる。
逆に何もないと、
一つひとつ確認しながら進めるしかなくなります。
目印があるかどうか。
それだけで、安心感も作業のしやすさも、かなり変わってきます。
過去の自分をほめたくなる時と、殴りたくなる時
コードを触っていると、ふと思うことがあります。
過去の自分をほめたくなる時と、殴りたくなる時があるな、と。
過去の自分をほめたくなる時
コメントが残っていて、意図が追えるときです。
「ああ、ここでこういう分岐にしてるのか」
「この処理はこのケースを潰すためか」
少しずつ、当時の自分の考えが見えてきます。
過去の自分を殴りたくなる時
逆に、何も残っていないときは後者です。
処理を一つずつ追って、仕様を推測して、動作を確認して……
正直、かなりしんどいです。
「これ消していいやつか？」
「触ったらあかんやつか？」
そんなことを一つずつ判断しながら進めることになります。
コードは読める。でも、意図が分からない。
これが一番怖い。
これが一番厄介です。
なぜコメントがないと修正が難しくなるのか
コメントがない状態でのプログラム修正は、
とにかく「把握するところ」からスタートになります。
把握することの難しさ
このコードは何をしているのか。
このあたりの処理は、どんな役割なのか。
一つひとつ判断しながら読み解いていく必要があります。
コード自体を読めば、処理の流れはある程度分かります。
ただ、「なぜそうしているのか」までは分かりません。
コードは読めても、意図は残らない。
この差が、思っている以上に大きいんですよね。
あるかないかで判断が変わる
本当に必要な処理なのか。
過去の不具合対応で入ったものなのか。
特定の条件を回避するためのものなのか。
こういった判断ができないまま触るのは、正直かなり怖いです。
さらに怖いのが、「理解したつもり」で修正したときです。
ちょっとした処理のタイミングの違いで、普通にバグります。
「え、なんで？」ってなるやつです。
表面的には追えていても、前提や意図が分かっていないと、
少しの変更で簡単に崩れてしまいます。
ちなみに、
「理解できないコード」どころじゃない状況もあります。
データが消えたときは、もうそれどころじゃなくなります。
頭ではわかっていても
こういった場面で、安全策を取るなら、
一度コメントを書き起こしながら整理していくのが確実です。
ただ、現場ではそうも言っていられないことも多いです。
急ぎの対応だったり、影響範囲が読めなかったり。
コメントを書きながら進める余裕がなく、
その場で解読していくしかないこともあります。
だからこそ思うのは、
「後から書く」のではなく、「そのとき残しておく」ことの大切さです。
結局のところ、
過去の自分が何を残していたかで、すべてが変わるのかもしれません。
過去の自分よ、頼むからコメント入れておいてくれ。
……と、思うことは何度もあります。
ただ、今の自分がちゃんと入れるかと言われると、正直怪しいところです。
それでも、少しでも残しておけば、
未来の自分が少し楽になるのかもしれません。
▼ 関連記事（おすすめ）
今回のような「コードが分からない」話とは別で、
実際に“もっと怖い状況”に遭遇したこともあります。
正直、あのときは「どうしようもないかもしれない」と思いました。
「もしこの記事が役に立ったと感じたら、SNSでシェアしていただけると嬉しいです！」
その際、インスタグラムやX（Twitter）で**「フォロー」や「シェア」**してもらえると、次の記事を書く大きな励みになります！
他にもSEの裏話や便利なガジェットやちょっと一息つけるようなコラムも用意していますので、ぜひご覧ください。
