LoginSignup
2
0

More than 1 year has passed since last update.

if else のコメントの場所

Posted at

条件の前にコメント入れる派

メリット
  • コメントの後に処理があるので読み易い
デメリット
  • elseは、上のブロックの中に次のブロックのコメントがあるので読み誤る
  • (フォーマッタによっては)コメントの列がずれる
        //正常パターン
        if (s == 0) {
            System.out.println("正常処理");
            //警告パターン
        } else if (s == 1) {
            System.out.println("警告処理");
            //エラーパターン
        } else {
            System.out.println("エラー処理");
        }

(例はJava.比較のために空行はすべてなし)

コピペとかミスりそう.

条件の後にコメント入れる派

メリット
  • 該当処理ブロックの中にコメントがあるので読み誤らない
デメリット
  • 条件の後にコメントがあるので、行ったり来たりになる
        if (s == 0) {
            //正常パターン
            System.out.println("正常処理");
        } else if (s == 1) {
            //警告パターン
            System.out.println("警告処理");
        } else {
            //エラーパターン
            System.out.println("エラー処理");
        }

条件の後にコメント入れる派(圧縮派)

メリット
  • 該当処理ブロックの中にコメントがあるので読み誤りにくい
  • 行数が少ない
デメリット
  • 条件の後にコメントがあるので、行ったり来たりになりやすい。
  • コメントの始まりの列が条件によってバラバラ.比較しにくい
        if (s == 0) {//正常パターン
            System.out.println("正常処理");
        } else if (s == 1) {//警告パターン
            System.out.println("警告処理");
        } else {//エラーパターン
            System.out.println("エラー処理");
        }

ブロックの後にコメント入れる派

メリット
  • コメントの後に処理があるので読み易い
デメリット
  • いつものelseの位置と異なるので違和感がある
        //正常パターン
        if (s == 0) {
            System.out.println("正常処理");
        } //警告パターン
        else if (s == 1) {
            System.out.println("警告処理");
        } //エラーパターン
        else {
            System.out.println("エラー処理");
        }
2
0
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
0