keyborad

コード改修の心得



コードの改修中に様々な罠があり、それが地雷になって後日爆発!ってのがあります。
今回はそんなコード改修の様々な罠と注意点を書いていきます。

ソース改修の心得

私がソース改修時に気をつける3箇条です。
ただ、現場によっては直し方などは開発規約で決まってたりするので注意してくださいね。

1.影響範囲を調べろ
2.不要なコード、コメントアウト、コメントは削除しろ
3.変更履歴を付けろ

影響範囲を調べろ

影響範囲を調べないで改修を行うな!

複数の箇所から呼びだされている処理を改修する時に以下の様なことが発生します。
仕様変更がされた1箇所の対応→他の箇所は既存のままの仕様→共通関数を改修→他の箇所でも使用されているのでエラーが発生する。

共通で使用されている関数を直す時は、他の箇所で使用されているかの有無をよく調査してください。

それとは逆に仕様変更がなされた箇所と同様の処理が別個に入っている箇所についても仕様変更を行うのかの確認が必要です。
後々、仕様の統一が図れてないと言われて確認することがあります。

不要なコード、コメントアウト、コメントは削除しろ

たまにあるのが、バグ毎にコメントを入れて、改修前のソースを全コメントアウトする人・・・
多分、今時の開発環境ではSVNやGitなどのバージョン管理システムを使用しているはずなので、以前のコードがログとして残っているので大丈夫です。
不要なコードやコメントアウト、コメントは残っていると混乱の原因になることもあります、不要なら削除して必要になったらコードのログを見ればいいんです。

不要なものは混乱の原因や、コードの可読性を落とすのでやめましょう。
バージョン管理システムを使ってないなら使うことを推奨します。

変更履歴を付けろ

変更履歴を付けるようにしてください。
これはバグ発生時などに後々役立ちます。
いつ、何の改修で発生したのか、原因を追いやすく、上司や顧客に説明しやすくて助かるのです。
SVNやGitへのコミットログが「改修しました。」だけの時は、何をやったからわかりません。



簡単ですがこんな感じですね。
細かく言えばもっとあるでしょうが、みなさんも爆弾処理が爆弾作成にならないように気をつけてください。


コメントを残す