こんにちは、意識低い系サラリーマンのKENです。
今回は零細IT企業でシステムエンジニアをしている僕が遭遇した酷いコメントについて。
猫でもわかるC#プログラミング 第3版 (猫でもわかるプログラミング)
- 作者: 粂井康孝
- 出版社/メーカー: SBクリエイティブ
- 発売日: 2016/02/27
- メディア: 単行本
- この商品を含むブログ (2件) を見る
通常プログラムを組むときは、プログラミング言語を使ってソースコードを書いていきます。でもプログラミング言語だけでひたすら書いていると、第三者が読んだときや後から自分で見返したときにわかりづらいので、「コメント」と呼ばれるメモ書きを付記することがあります。あります、というかほとんどの人はそうします。
例えば、「C#」というプログラミング言語だと、行の先頭に「//」と打つと、その行はプログラムの一部としては解釈されず、単なるメモ書きとコンピュータには見なされます。
// データベースから売り上げ情報を取得する
こんな感じ。こういうコメントがあるのと無いのとでは、可読性が全然違います。
さて、いまを遡ること10年ほど前。
会社の先輩が一身上の都合で会社を退職していき、僕は先輩が担当していたシステムを引き継ぐことになりました。
で、そのシステムの改修をすることになったのでソースコードを見てみたら、システムの肝に近い部分にこんなコメントがあったんですよ。
// その場しのぎの処理。仕方がない。
( ﾟдﾟ)
(つд⊂)ｺﾞｼｺﾞｼ
(；ﾟдﾟ)
(つд⊂)ｺﾞｼｺﾞｼ
_, ._
（；ﾟ Дﾟ）
いやいや、ちょっと待ってくださいよ先輩。
なんスか、このLINEで友達と会話しているようなノリのコメントは。
「その場しのぎの処理」は・・・まあ、わかります。
新機能を実装するときにまだ仕様が固まってなかったりとか、不具合の根本原因がわからないときにとりあえず動くようにするとか、いろいろな理由で暫定的なコードを入れるのはよくあること。まあ、それにしたって普通は「暫定処理」とか書くものですが。
これじゃあまるで先輩がバグを直せずに、その場しのぎのコード書いて退職という名の逃げを打って後輩に押し付けてるみたいじゃないですか、やだなー。
・・・あれ？なんかいままさに僕が置かれている状況に似てるな。偶然の一致かな？
で、後半部分。
「仕方が無い。」って何だよ！
これもうコメントでも何でもないよ！
ただのアンタの感想というか泣き言じゃねーか！！
というか、実際泣く羽目になったのは、「その場しのぎの処理」を解読して直すことになった僕なんですけども。先輩が急な退職ということもあって、まともに引き継ぎも行われず、この部分の設計書も存在していなかったために、解読業務は困難を極めました。
それならばせめてコメントだけはまともに残していって欲しかった・・・
今回はこのあたりで。
【関連記事】
*1:実際のコメントをそのまま書くと問題ありそうだから、少し改変してます