日記/2008/12/04/ifブロックのコメントの付け方

最近個人的に好きになった if ブロックのコメントの付け方。

if (condition_1_is_true) {
    // condition_1 is true
    ...
} else if (condition_2_is_true) {
    // condition_2 is true
    ...
}

実は今まで、下のようなコメントを書く時もあったのですが・・・

// condition_1 is true
if (condition_1_is_true) {
    ...
}

これだと、下にelse ifなどのブロックを付け足す時、付け足すブロックのコメントをどこに書けば良いのか困る時があるわけです。

というわけで、ifブロックでコメントを付ける時・・・

• ifブロック全体の内容をコメントする時は最初のifの前に書いておく。
• 個々のifブロックの条件の内容をコメントする時は、個別のifブロックの中に書いておく。

というような感じになるように最近は気をつけてます。

// ほげほげを分岐するブロックです：ifブロック全体の内容
if (cond_1_is_true) {
    // cond_1 が真の時：個別のifブロックの内容
    ...
} else if (cond_2_is_true) {
    // cond_2 が真の時：個別のifブロックの内容
    ...
}
...