コメントアウトから探るソースコード考古学

保守を行う際には、「ソースの理解」という段階が必須になります。
これを行わないと思わぬ悲劇の原因となります。
そういうわけで、最も重要な作業の一つであるわけです。
そんな作業の中で、コメントアウトされたソースの塊に出会うことがあります。
確かに、親切に『コメントアウトされた理由』が書いてあることがあります-如何に笑える理由であろうと、それは有難い事です。
そうでない場合-単にコメントアウトされている場合-には、コメントアウトされた理由は推測するしかない訳です。
その理由が明らかな場合もあります。
あからさまなデバック用コード(っていうか、#IF DEBUG つかえよ…)、あからさまな間違い、そういう場合が多いわけです。
しかしながら、そういう推測が成り立たないケースもあります。これが曲者です。
なぜコメントアウトされたのか。
仕様変更なのか?或いは、テストで悲劇が起きたためなのか。
さらに、そのコメントアウトと同様なコメントアウトが随所に見受けられるとなれば、『何かある』と感じるべきでしょう。
>新規開発な方へ
無意味なコメントアウトはおやめください。
せめて、その理由は記述してください。
或いは、ソース管理ツールに身を委ねて消してしまうのもアリです。
>保守な方へ
発掘作業が終わったら、そのコメントアウトは消してしまいましょう。
或いは、後から来る人のために、敢えて残して、その理由を記述するのも良いアイディアです。
まぁ、私に言えた立場か!というアレはありますが…

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Spam Protection by WP-SpamFree