- PR -

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

1|2|3 次のページへ»
投稿者投稿内容
あらぶ石油小僧
会議室デビュー日: 2005/08/15
投稿数: 11
投稿日時: 2005-08-31 15:23
いつも勉強させてもらっています。

とりとめのない質問で申し訳ないのですが、
みなさんはどうしてるのかふと疑問に思いました。

コード:

//フラグがTrueの時
if(bFlg == true)
{
}
	//フラグがFalseの時
else
{
}

if文のコメントをかいているわけですが、
デフォルト状態だと上記のようにelseの条件コメントがタブ１個分ずれちゃいます。

if文のコメントというのは、
if{}の中身に書くのが普通なのでしょうか？

どうもそれだとわかり難いような気がして。。。
すいませんがみなさんがどのようにコメントを記述しているか教えてください。
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2005-08-31 15:34
引用:

if文のコメントをかいているわけですが、
デフォルト状態だと上記のようにelseの条件コメントがタブ１個分ずれちゃいます。

私は、コードの再フォーマットを無効にしてますね。

コメントは、elseif でもない限りは先頭にしか書かないッスね。



_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
たかさご
会議室デビュー日: 2005/01/25
投稿数: 6
お住まい・勤務地: 大阪
投稿日時: 2005-08-31 15:59
同じく基本は先頭に書く派です。

もし、書くなら、

コード:

// 大雑把な説明（なしてこの判定が必要か等）
if (bFlg) {
    // 真の意味
}
else {
    // 偽の意味
}


ってなトコですかね。
あらぶ石油小僧
会議室デビュー日: 2005/08/15
投稿数: 11
投稿日時: 2005-08-31 16:03
じゃんぬねっとさんお返事ありがとうございます。

引用:

じゃんぬねっとさんの書き込み (2005-08-31 15:34) より:

私は、コードの再フォーマットを無効にしてますね。


ツール -> オプション -> テキストエディタ -> Basic -> VB固有

の中にコードの再フォーマットを無効というものはありますが、
C#の場合だと、そのような機能はない？のでしょうか？
Gio
ぬし
会議室デビュー日: 2003/11/28
投稿数: 350
お住まい・勤務地: 都内から横浜の間に少量発生中
投稿日時: 2005-08-31 16:05
人によって好みがありますが、私の場合をば。

コード:
// なんたらの判別
if (nantara == true) {
// なんたらな場合
// うーたらして、成功した場合は続けてこーたらする。（←このブロックで実行する処理の粗筋）
...
} else {
// なんたらでない場合
// かんたらするだけで良い。
...
}


処理に対するコメントはその処理ブロックの中に行頭から書くというポリシーなので、まるっきり悩みません

フィールド宣言に対して、フィールドの意味を宣言の後、同じ行に書くというスタイルを以前は使っていました。
コード:
int kantara = 0; // かんたらの値

これも Java や C# の場合、コメントを処理してドキュメントを生成する環境があるので、それで生成したものを見るようになってからは、気にせずに前の行で行頭から書くようになりました。
あらぶ石油小僧
会議室デビュー日: 2005/08/15
投稿数: 11
投稿日時: 2005-08-31 16:16
たかさごさん、Gioさん書込みありがとうございます。

引用:

たかさごさんの書き込み (2005-08-31 15:59) より:
コード:

// 大雑把な説明（なしてこの判定が必要か等）
if (bFlg) {
    // 真の意味
}
else {
    // 偽の意味
}

Gioさんの書き込み (2005-08-31 16:05) より:
人によって好みがありますが、私の場合をば。

コード:
// なんたらの判別
if (nantara == true) {
// なんたらな場合
// うーたらして、成功した場合は続けてこーたらする。（←このブロックで実行する処理の粗筋）
...
} else {
// なんたらでない場合
// かんたらするだけで良い。
...
}

処理に対するコメントはその処理ブロックの中に行頭から書くというポリシーなので、まるっきり悩みません

お二人がおっしゃるように、
やはり処理ブロック内に記述するようになっているんでしょうか。

そのような書き方をすれば、
実際タブ１個分ずれるということに関しては悩まなくなることですし。。

慣れるしかないのかなぁ・・・
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2005-08-31 16:18
引用:

ツール -> オプション -> テキストエディタ -> Basic -> VB固有
の中にコードの再フォーマットを無効というものはありますが、
C#の場合だと、そのような機能はない？のでしょうか？

VB の場合、コードの再フォーマットが有効になっていると、
どれだけ頑張っても戻されちゃいますが、
C# だと勝手にフォーマットされないハズなので、
一度 Tab を消してしまえばお好みの位置に書けません?

私はそれで else if については合わせて書くことがあります。
else についてはコメントは必要ないッスね。



_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
あらぶ石油小僧
会議室デビュー日: 2005/08/15
投稿数: 11
投稿日時: 2005-08-31 16:33
じゃんぬねっとさん再び書込みありがとうございます。

引用:

じゃんぬねっとさんの書き込み (2005-08-31 16:18) より:

VB の場合、コードの再フォーマットが有効になっていると、
どれだけ頑張っても戻されちゃいますが、
C# だと勝手にフォーマットされないハズなので、
一度 Tab を消してしまえばお好みの位置に書けません?

はい。いままで、そのように一度Tabを消して、
望む位置に無理やり移動させていましたが、
みんなも同じようなことをやっているのか？
もしかしたら、もっと賢いやり方があるのではないか？とふと疑問に思って
投稿させて頂きました。

引用:

else についてはコメントは必要ないッスね。

そうなんですねぇ。。
私はちまちまと書いてたりしました。
1|2|3 次のページへ»

スキルアップ／キャリアアップ（JOB@IT）