ソースにコメントで履歴を残すということ

ひと通りのコーディングを完了し、動作確認まで済ませた後、

顧客担当者に差分レポートと差分のソースを送付した。

 

ソースを送り暫くしてから鳴る、1本の電話。

 

「あのー、ソースを変更して欲しいんですけど…。」

 

なんだ?仕変か?と思いつつ、彼女の話を聞く。

 

「今回幾つかの処理を削除していますけど、跡形もなく消していますよね?」

「コメントで残しておくのが正解だと思いますけど…。」

 

確かに彼女の言うとおり、僕は今回の対応では、

ソース上にコメントで履歴を残すことなく処理を削除していた。

彼女は続ける。

 

「今までもこうだったんですか?」

 

僕は答える。

 

『いえ、今回からこのカタチにしました。』

 

そもそも、履歴をコメントで残すことは、

僕が始めたことではない、そして顧客担当者が始めたことでもない。

僕の前任の担当者が始めたことだ。

僕としてはこの悪しき風習をここで断ち切っておきたかった。

 

『ソース上にコメントで履歴を残すことは可読性が下がるので、

 今回から止めたいと思います。』

 

彼女は答える。

 

「そうかもしれませんけど、今まではコメントで履歴を残していたんですよね?」

「今更ソレを急に変えるのは…。」

 

僕は返す。

 

 『コメントで履歴を残すことはアンチパターンですし、VSSで管理されているので、

 コメントで残さないほうが正解です。』

 

「かもしれませんけど、最初からこの形であったようにしてしまうってことですか?」

 

『ソース上ではそうなりますが、VSSでソース管理されているので問題ないはずです』

 

「でも、そうなったら昔のバージョンとの比較が大変になりますよね?」

 

『ツールでDIFFを取れば問題無いです。』

『もし、コメントで履歴を残すことを続けていたら、5年後、10年後は、

 このソースは読めたもんじゃなくなりますよ?』

 

「でも…、この状態じゃ…受け取れないですよぅ…。」

 

仕方なく僕はソースを変更することに了承した旨を伝え電話を切り、

送ったソースに技術的負債をせっせと詰め込む作業を行うのだった。 

 

 

【教訓】 

 何かをやめるという事は、場合によっては始める以上のエネルギーが必要な場合が

往々にして存在する。