すぐに戻せるようにコメントアウト、それがいつまでも残り続ける

Author:
pg

ソフトウェア開発においてよくあるのですが、とりあえずコメントアウトしておく、ということ。
ちょっと自信ないとかABテストのような感じで、すぐに戻せるようにしておくわけです。
が、これ気が付くとずーっとコメントが残ってしまったり。
そして担当者がいなくなって謎のコメントとして語り継がれる、と。

あるあるですけど、こういうの良くないですなあ。

防ぐにはどうすべきか。
なぜコメントアウトしたのかを書いておくべきか。
それともリビジョン管理に任せてコメントアウトなんてものは無くすべきか。
あって悪いものじゃないけど、永遠に使わないのなら消してしまったほうがいいし。

ってことでどこかのタイミングでメンテナンスってしたほうがいいんですよね。
不要なコメントを消すとかリファクタリングするとか。
一年読まない本は捨てる、とか断捨離的なテクニックがあるように、一年外したことのないコメントは取り払うとかルールつけるのもいいかも。
こういう保守ってどうしてもぱっと見何も変わらないから後回しにされがちだけど、しっかり工数は取りましょう。
長い歴史のあるソースコードはこういう事していかないとグチャグチャになってしまいまっせ。

そしてブラックボックスが増えて誰もメンテナンスできなくなってしまったのなら作りなおすことも考える事。
もちろんそれによるデグレは出てくるでしょうけど、長い目で見れば確実にやって良かった、と思えるようになります。

品質を上げるためにも、作りなおしをためらわないようになると良いですね。

Share on Facebook
Pocket