@kotyのブログ

.NETとかJavaとかPythonとか勉強会のこととかを、田舎者SEがつづります。記事のライセンスは"CC BY"でお願いします。

古いコードをコメントとして残すか否かの不毛な議論

世間一般では既に結論が出ているんだとは思いますが。未だに議論がある、というかようやく議論が起きてきたという状況(汗。

コメントとして残せ派

  • リポジトリがもし消えた時に過去の変更も消えちゃって困る
  • 直近の版を見るだけで変更の経緯を追いやすい
  • コードが見にくくても気合でやれ

コメントは不要だ派

  • リポジトリのバックアップは取るだろ、jk
  • VSS、SVN等のSCMを使えば過去の経緯は分かるだろ
  • いらんコメントがあったらコードが見にくいだろ

何言ってんだよ結論は出てんだろ、とおっしゃる方が大多数だとは思いますが、一応論点を絞ると「どうなっていれば、改修がしやすいか?」になると思います。

  • 改修実作業前の調査のしやすさ。(修正の経緯の読み取りやすさ)
  • 改修実作業のしやすさ

どちらを重要視するかで、古いコードをコメントとして残す/残さない の判断が分かれてくるのではないでしょうか。

とはいえ、このようなご指摘があり。。


どんな形で過去のソースコードを残すにしても「何故」が読み取れることはまずなく、だったら残さなくて良いだろう、という話になろうかと思います。
こんな議論をするよりもむしろ、tracやTFSなどでタスク(←ここに「何故」が含まれている)と変更セットを関連づけることにより「何故」を追いやすくすることを考える方が前向きなのでしょう。

ああ、TFS使いたい。