プログラマメモ2 - programmer no memo2

[コーディング全般]ソースコードの修正箇所に日付を入れることについて 2006/07/14
2006/11/26

これはNGだと思うこと。



ソースコードの修正箇所に日付しか入ってない。



たとえば、



// 8/23 XXXXに対応 S.Nakawaka

a = b + c;





こんな風にソースコードに修正コメントが入っていたら頭がくらくらする。



上記の例だと、最低でも年月日にしないとだめ。



それ以上に修正箇所に日付を入れること自体、よろしくないことだと思う。

その日付が後から意味をなすことなんて、ほとんどないと思うし、《場当たり》的すぎる。



ましてやソースコード管理用のツール(CVS等)を使用しているなら、中途半端に日付を入れなくてもいいのではないかだろうか。



コメントいれるならもっと説明を加えたほうがよいだろう。



おそらくこういったコードに対する修正というのは、あとから誰も手をつけれない《魔の領域》になる可能性が大だと思う。



この魔の領域は拡大してはじめてそのソースコードを廃棄してゼロからつくることになるのかもしれないのだろう。

: