- PR -

if文を使う時のコメントの書き方(C#)

投稿者投稿内容
NAL-6295
ぬし
会議室デビュー日: 2003/01/26
投稿数: 966
お住まい・勤務地: 東京
投稿日時: 2005-08-31 16:57
NAL-6295です。

私の場合、基本的に余程トリッキーで分かりにくいコードで無い限り、コメントは書かないです。
むしろ、分岐の理由が分かるような命名をするようにしています。
確か、前にもそんなスレッドがありましたね。
http://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=11227&forum=3

[ メッセージ編集済み 編集者: NAL-6295 編集日時 2005-08-31 16:59 ]
あらぶ石油小僧
会議室デビュー日: 2005/08/15
投稿数: 11
投稿日時: 2005-08-31 17:09
NAL-6295さん書込みありがとうございます。

引用:

NAL-6295さんの書き込み (2005-08-31 16:57) より:

私の場合、基本的に余程トリッキーで分かりにくいコードで無い限り、コメントは書かないです。
むしろ、分岐の理由が分かるような命名をするようにしています。


確かに、必要のないコメントってたくさんあるかもしれません。
ただコメントなしで簡単でわかりやすいソースが書けているかどうかは、
かなり怪しいところです。

とても考えさせられるコメント・リンクありがとうございました。

もっとがんばろう・・・
たつごろー
ぬし
会議室デビュー日: 2004/10/25
投稿数: 496
投稿日時: 2005-08-31 17:38
仕様をコードに落とし込む過程で情報が欠落していきます。
それは漢字をひらがなに書き換えるようなもので、別のものに変換する過程では避けられないことです。
そこで、失った情報をコメントで補完しなければならなくなります。

情報が失われないように書くことでコメントが不要になります。うまく書ける人はこうします。

うまくかけない人ほど貴重な情報を減らしてしまい、嫌なにおいのするコードになって、消臭剤としてのコメントが多くなってきます。

必要なコメントは何百行あってもかまわないとも思います。
しかし、不必要なコメントや無意味な改行は1文字たりとも許せません。

_________________
たつごろー
codeseek
こみゅぷらす
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2005-08-31 17:40
引用:

あらぶ石油小僧さんの書き込み (2005-08-31 17:09) より:

確かに、必要のないコメントってたくさんあるかもしれません。
ただコメントなしで簡単でわかりやすいソースが書けているかどうかは、
かなり怪しいところです。(^_^;)


このあたりを一通りみてください。
クラス ライブラリ開発者向けのデザイン ガイドライン

たとえば、名前空間・クラス・メソッドをとっても、
意味のある名前でないと何なのかわかりません。

実際に見たことのある良くない例 (CODING HORROR)
Common.ComClsFanc.CheckNumber("123,456")



_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
trapemiya
大ベテラン
会議室デビュー日: 2005/07/30
投稿数: 102
投稿日時: 2005-08-31 18:49
ちょっと話が逸れて申し訳ないんですが、SQL serverのストアドプロシージャは、私にとってもっと気持ち悪いんです。

コード:
IF @hoge IS NULL
	BEGIN
	END
ELSE
	BEGIN
END



もなんか気持ち悪いし、

コード:
IF @hoge IS NULL
	BEGIN
	END
ELSE
	BEGIN
	END



もなんか気持ち悪い。

#関係ない話ですみません。
nodera
大ベテラン
会議室デビュー日: 2003/09/08
投稿数: 200
投稿日時: 2005-08-31 19:43
こんにちは。

おいらの場合、ストアドはこうです。
コード:
IF @hoge IS NULL
BEGIN
    -- 真の場合のコード
END
ELSE
BEGIN
    -- 偽の場合のコード
END



BEGINとENDを、C#(C/C++等)の{ }と同じ意味(位置)で書いてます。
ELSEがちと見にくいですが。
ya
大ベテラン
会議室デビュー日: 2002/05/03
投稿数: 212
投稿日時: 2005-08-31 20:16
コード:

IF @Hoge IS NULL BEGIN
	--Codes When IF-Expression is True
END ELSE BEGIN
	--Codes When IF-Expression is False
END



ええ、C#でもC++でも { は行末に残す派です。
かつのり
ぬし
会議室デビュー日: 2004/03/18
投稿数: 2015
お住まい・勤務地: 札幌
投稿日時: 2005-08-31 20:22
私の場合、
コード:
//大雑把な説明
if(hoge){
    //ケース1の説明
}else if(hoge2){
    //ケース2の説明
}else{
    //上記に該当しない場合
}


って書き方ですね。elseifがない場合は
ifブロックの前のコメントで済むことが多いので
ifブロック内のコメントは殆ど書きません。

ちなみに余談ですが、
コード:
//変数hogeに10を代入
int hoge = 10


って感じの、「見ればわかるコメント」が
書いてあった事があってビックリしました・・・

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