もう嫌だ！と思ったソースその②

それほど嫌でもないですが、これから開発するにあたって、気を付けておくといいことを
メモしておきます。

プログラムの改定履歴のつけ方について
改定履歴とは不具合修正や仕様追加などでプログラムソースの変更が必要になったときに
残すコメントのことで、私が携わった仕事では必ず改定履歴はありました。
記載内容はプロジェクトの規約によって異なりますが、大抵は改訂番号、日付、変更者、
変更理由などで構成されます。

今日思った、大変だなぁと感じたのはこんなソースです。
改定履歴からソースを見直す作業は滅多にありませんけど＾＾；


一見、問題ありません。気になるのは#01の修正で一気に3つもの対応が入ってるとこです。
このソースでも変更箇所を追えます。ですが！ある一部の箇所だけ見たい、例えば不具合B
に修正漏れがあり、さらに修正が必要だ！となったときこのソースだと#01で変更した箇所を
全て確認する必要があります。



修正者は少し手間がかかりますが、上記のように記載していれば、後で不具合Bの修正を
見直すとき非常に楽です。#01でまとめられた場合、本当に不具合Bを修正した処理なのか
疑いながらソースを見ていく必要があるので時間がかかります。