どうも、カネスズです。
プログラマとしてシステム開発をしていると、ソースコードに対してコメントをよく書き込みます。可読性を上げるため、処理に対する補足のため、なぜそのような処理にしたのかの経緯を記すためなど、コメントの要素は様々です。
そんなコメントですが、プログラマをしているとシステムの改修を行う際に、他人が書いたプログラムのコメントを見る機会が結構あるのですが、コメントというのは性格が出るもので、眺めていると「意味不明なもの」「ツッコミを入れたくなるもの」など、面白いものが多いです。
という訳で今回は、私が見て面白いと思ったコメントを５つご紹介していきたいと思います。
私が遭遇した面白いコメント５選
以下が今回ご紹介する５つのコメントです。
- プログラムに欠陥があることを必死に伝えてくるコメント
- 仕様が決まらない愚痴
- 後でやる！
- 俺は悪くない！
- 復活の呪文
面白い中にも、プログラマの苦悩が詰まったコメント達です。是非見てみてください。
プログラムに欠陥があることを必死に伝えてくるコメント
プログラミングをしていると、原因不明のバグが出てくることがよくあります。いずれはバグの原因を究明し修正するか、また別の処理に変更するなどしてバグが発生しない状態までもっていかなくてはいけません。
しかし、私が遭遇したコメントは「どうしてもバグの原因が分からない！」「ほかの手段もない！」と３行にもわたって、プログラムの欠陥を痛切に記したものでした。
要約すると、以下の通りです。
○○の状況でバグが発生しやすい！でも必ず出るわけではない！私には分からない！
……まあ、あるあるですね。
たまに起こるバグというのは本当に厄介で、原因を突き止めることは本当に大変です。実際はしょうもない理由だったりするんですけどね。
しかし、バグを残した状態でシステムをリリースしていい訳はないのですが、この方は諦めてしまい、たまに起こるという点を付いてテストもすり抜けたのでしょう。
そのプログラムは引き受けたシステム改修の範囲外だったため、手を付けませんでしたが当時担当した人はテストでバグが露見しないかビクビクしていたことでしょう……。
それなら、コメントを残さないほうが良かったのでは？と、思ったり思わなかったり。
仕様が決まらない愚痴
システムはお客さんと打ち合わせを何度も行い、仕様が定まってから作るのが普通なのですが、たまに仕様が決まっておらず曖昧なまま開発が始まってしまうことがあります。
私が遭遇したのは、そんな時の心境をコメントに残したものでした。
- 仕様が決まってないのに開発を始めるんじゃない！
- スケジュールは伸ばしてくれないんだろう？
- 後で仕様と違うと揉めるんだろうな！
など、上記程露骨には書いてありませんでしたが、要約するとこんな感じです。
気持ちは分かりますが、そのコメントを残しておくのはどうかと……。消し忘れたのか、それともあえて……。
後でやる！
システム開発を行っていると、とある機能については後回しにすることがあります。理由は様々で、上述した仕様が決まっていないことや、単純に面倒くさいからなど色々あります。
そんな時に使うのが「TODO」というコメント。TODOの後に残っているタスクを書き込んでおき、やり残しがないように目印を付けておく訳ですね。
私がシステムの改修を行う際に遭遇したのは「TODO：○○ 後でやる！」というものでした。システムの改修を行う段階で、TODOがあること自体に問題があるのですが、まあ消し忘れたのかな？と思ったのもつかの間……
やってないじゃねえか！
その機能がごっそり抜け落ちていました。なぜこれでリリースできたんだ？。機能としては実装したものの、実際の現場では使われないという機能はたまにありますが、それでもテストは行うはず。
不思議です。
俺は悪くない！
上述した、仕様が決まらないことへの愚痴と似ていますが、システムの動作がこのコメント主
には気に食わないらしく、上流工程と揉めたことへの愚痴が書かれていました。
- この仕様じゃお客から絶対変更依頼が来る！
- 俺は指摘したけど上流の奴らが頑なに変えようとしない！
- より良いシステムを作るのはエンジニアの務めだろ！
というようなことを遠回しに書き記してありました。とてもこだわりの強く、素晴らしいエンジニアの方だと思います。まあ、コメントにしておくのはどうかと思いますが。
結果的に、コメント主の予想通り改修依頼が来た訳で、私が担当することになりました。やはり、ユーザーを第一に考えたシステムを作るというのは大切ですね。
復活の呪文
私が遭遇したのは、ドラゴンクエストに出てくる復活の呪文のような謎の文字の羅列です。
その呪文とは
かねい；かんじょげ；あ；いあくぁｗせｄｒｆｔｇｙふじこｌｐ；
みたいな感じです。
……狂気を感じますね。想像を膨らませると、納期に追われ徹夜してコーディングを行っている際に、ついに精神が崩壊してしまったのではないかと……。
コーディング中に眠ってしまい、キーボードを適当に押してしまうのであればまだ分かりますが、しっかりとコメント化し、誰も気づかず消されていないあたりが恐ろしいです。
おわりに。
ここまで、私が遭遇した面白いコメント達を５つご紹介してきましたが、いかがでしたか？
私個人としては面白いコメントを見るのは楽しくて好きなのですが、本来であれば真面目に要点をついてものだけを書くのが望ましいです。
ここで紹介したコメントの真似をしないよう、ご注意ください。
それでは今回はこの辺で。
ではでは！