バージョン管理にコメントを残したとしても、ソースコードに改訂履歴のコメントを残す必要があるという主張 – プログラマとSEのあいだ
これは考え方は人それぞれかもなぁ。
履歴を重要視するか、最新のソースの「今の実装状態」を重要視するかにもよるだろうし…。
私はあんまりガチガチに履歴を残すのは嫌な派。特に修正して削除したところを全てコメントアウトして残しておく、というのが嫌い。例えばリリースを3回やったら、それ以前の修正履歴はクリーンにして、ファイルヘッダか別のChengelogにそれまでの修正の概要を写しておくとか、いつまでもソースコード上に履歴が残らない工夫もあって良いと思う。追加や削除履歴が山のように残ってるソースなんて読めやしないと思う。
チケットシステムと組むのなら、できるだけチケット1件で1コミットが良いと思うけどそれはそれで一気に修正してしまった場合のコミットが面倒になったりするので、そこは簡単なチケット番号を修正コメントとして入れておくのはアリかと。その代わり、ソース上にガチガチな修正履歴は残さない、とか。
Similar Posts:
- 単体テストやTDDに対して感じていること
- 新人教育の計画中、だけどこれが難しい
- “IT業界で楽しく仕事をするための10カ条 – ＠IT”
- 未経験入社でも化ける人は存在する
- 大手でもプログラミングに関われる会社はある
No related posts.
