- PR -

ソース修正時にコメントでどう挟むか?

投稿者投稿内容
sand
大ベテラン
会議室デビュー日: 2007/01/15
投稿数: 247
投稿日時: 2007-11-18 13:33
ソースを修正する際のコメントの挟み方を考えています。
今書いているのはこんな感じですが冗長なような気がします。
それに何のための修正かがありません。
だれが修正したのかも書いていません。
そういった情報の欠落もありますがどこまで書くべきなのかもわかりません。
ベストな書き方って何か理論的、手法、○○法的なものがあれば知りたいです。
よろしくお願いします。


<修正前>
String a

<修正後>
//修正Start
//修正前コードStart
//String a
//修正前コードEnd
//修正後コードStart
String a =
//修正後コードEnd
//修正End
さいくろう
大ベテラン
会議室デビュー日: 2005/11/19
投稿数: 170
お住まい・勤務地: 川崎市
投稿日時: 2007-11-18 13:59
・・・。







cvsかsubversionを使え。

<追記>
思わず反射的に投稿してしまったが、なんか頑張ってらっしゃるようですな。

[ メッセージ編集済み 編集者: さいくろう 編集日時 2007-11-18 14:12 ]
七味唐辛子
ぬし
会議室デビュー日: 2001/12/25
投稿数: 660
投稿日時: 2007-11-18 15:23
ベストな書き方というのは。知りません。
自分の知る範囲では 修正番号 修正日 修正者をヘッダー
そして INSERT DELETE UPDATE などの識別フラグを付加する

こんなことやりたくないのあれば下記の発言を参考



じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2007-11-18 21:48
CVS か Subversion を使用する。

_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
a-san
ベテラン
会議室デビュー日: 2004/06/01
投稿数: 53
投稿日時: 2007-11-19 03:18
ちなみに私の場合はこんな感じです。
コード:
	// 2007/11/18 会社名 A.Watanabe MOD begin #0041 インジェクション対応
	//// 2007/10/30 会社名 eiichi MOD begin 商品コードは前方一致でも可とする
	////sql += "ITEM_CD='" + item_cd + "' AND ";
	//sql += "ITEM_CD LIKE '" + item_cd + "%' AND ";
	//// 2007/10/30 会社名 eiichi MOD end
	sql += "ITEM_CD LIKE '?%' AND";
	// 2007/11/18 会社名 A.Watanabe MOD end


工夫しているところは・・・
修正のカテゴリとしてADD/MOD/DELを使い分けます。
不具合や仕様変更の番号があるときにはそれを付加します。
修正の修正をしても元のソースが類推できるようにしています。
grepしてもコメントかどうか分かるように、/* */は使いません。
nagise
ぬし
会議室デビュー日: 2006/05/19
投稿数: 1141
投稿日時: 2007-11-19 15:42
私もsubversionを使いますね。
ごく短期的にはコメントアウトでソースを残すのはアリだと思いますが、
ちゃんとしたバージョン管理を使うのほうが、人間の手で運用するより
よほど信頼できるし省力化でき、かつ視認性も高まると考えます。

だってルールつくっても人間で編集するんだったらヒューマンエラーを避けられないでしょう?

手前味噌で恐縮ですがうちのblogで議論があったので参考まで。
http://blogs.wankuma.com/nagise/archive/2007/10/16/102359.aspx
わんこ
常連さん
会議室デビュー日: 2003/04/30
投稿数: 46
投稿日時: 2007-11-19 17:49
不要なコードは納品しない。(ただし、コーディング規約などに定められた処理の流れを示すようなコメントは除く)
可読性が下がる。

などの理由により、このようなコメントをしたことが私はありません。
それとネストが増えてくると逆にバグの原因になり得ます。
個人的に修正中の過程でコメントをすることがありますが、それは修正が終わった辺りで削除します。
皆さんがおっしゃっているとおり、構成管理ツールを利用します。
コミット時のコメントを必須にします。これが入って無くても、
最低限コミットユーザがわかるのでなんとかなります。

また、コメントが入ったままテストが終了し、
その後にコメントを削除した場合はテストのやり直しです。
削除する場合に必要なコードまで削除してしまうこともないとは限りませんから・・・。
burton999
ぬし
会議室デビュー日: 2003/10/06
投稿数: 898
お住まい・勤務地: 東京
投稿日時: 2007-11-19 17:53
そのようなソースコードを引き継いでメンテナンスしたことがありますが、
後からソースを読んだ時に、そのようなゴミコメントが役にたつことはないです。
ただ可動性が低下するだけです。バージョン管理システムを導入しましょう。

スキルアップ/キャリアアップ(JOB@IT)