« 【メモ】nslookupコマンド | トップページ | CPU使用状況を確認する »

2014.02.23

古いソースのコメントでの保持

ここのところ自分の知識定着化を兼ねて、毎日エントリーを行ってみている。
その過程で過去のエントリーを見直したりもするのだが、目から火が出るような記事もあるものだ(^^;

たとえば
 [ソースを消すのか消さないのか?]
あれから約10年……。抹殺したい黒歴史ですなw

無論、現在であれば答えはひとつ。
「ソース内に過去のロジックは残さない」
である。
自分がコードを修正している最中は、参考のために一時的コメントアウトということはあるが、プロジェクトとして共通保存するソースにはその痕跡を残さない。

このことの正しさを痛感したのは、以下のようなソースを見てしまったことがきっかけだった。

//この処理は間違ってる
////変数iをインクリメント
// i++;
// 12/03 ahhou 追記
//// i = i + 1;
i++;
//2005/10/31 yahhou 修正
//if(a == b){
//  call methodA(i);
// }
if(a === b){
  call methodB(i);
}
正直もう、何がなんだかわからなくなっていた。
プログラムの修正履歴を追っかけようにもahhou氏の修正とyahhou氏の修正のどちらが先に行われたのかわからないし、yahhou氏が使用するメソッドを変えたのも意味がわからない。

最善の策は一秒でも早くバージョン管理ソフトを導入し、こうした修正履歴をソースコードから解放することだ。
ソースの中に履歴等を残すためにはこの履歴管理の標準化を実施して、修正トリガー・修正者・修正内容などをコメントとして残さなければならない。
ソース内のコメントは重要なものであるが、こうした内容を開発標準に含めるのはちょっと不毛な気がする……

一方で改訂履歴についてはどこかで管理する必要がある。この辺についてはJAVADocの話と絡めてそのうち書いてみたいと思う。

とりあえず自宅のマシンにもSVNサーバを導入して、自分しか開発者がいないプロジェクトでもバージョン管理ソフトに任せることにしている(^^;

|

« 【メモ】nslookupコマンド | トップページ | CPU使用状況を確認する »

コメント

コメントを書く



(ウェブ上には掲載しません)




トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/2022/59171647

この記事へのトラックバック一覧です: 古いソースのコメントでの保持:

« 【メモ】nslookupコマンド | トップページ | CPU使用状況を確認する »