ソース中に変更履歴をコメントで残すことについて考えてみた

この問題を考えてみようとした背景

私が所属する組織にはソースを修正する場合には古いソースをコメントアウトし、
修正日付、修正内容(Redmineのチケット番号)の改定履歴をコメントで入れる
暗黙のルールがある、私が知っている限り社内のプロジェクトは全てこのルール
で運用されている。

今日若手でご飯を食べに行ったときに

コメント入れないでソースのいらない行削除したら注意されたのだけど。
Subversionで履歴管理してるのにソース中に残す必要があるのかね。

という話になった、私は残す必要ないと思っていると解答して、その場はみんなで、だよねーとなって
会話が終わってしまったのだが、残すメリットと残さないメリットを改めて考えてみようと思った。

コメントを残しておくといいこと

Subversionに凄い勢いでコミットしてしかも毎回同じコメントを入れる人がいると
障害番号xxxxの修正
でコミット履歴が埋めつくされる。
一個ずつ見てくの凄いめんどくさいのでgrepしたほうが早いときがある。

障害番号xxxx、xxxx、xxxxの修正と関連性のない修正を一気にコミットしたときに
どの修正がどのチケット番号のかよくわからないことがある。そんな時ソースを障害番号でgrep
したら修正箇所がわかる。

※私のプロジェクトで実際に起こっていてあってよかったと思ったことを書いてみた。
このようなことをすること事態を防げばよいのだが。

コメントを残さないといいこと

ソースの8割コメントアウトなんてソースがある、コメントアウトされていない箇所を探
すのが大変、ていうか汚い。

まとめ

改めて考えてみるとなかなか思いつかないが、残しておくといいことは運用で防げる
ので残さなくてもいいんじゃないかなと思った。

スポンサーリンク
レクタングル大広告
レクタングル大広告

シェアする

  • このエントリーをはてなブックマークに追加

フォローする