【Java】ソースをきれいに書くための空白と改行

全く同じコードでも、 改行や空白が綺麗に入ってるソースって、 見やすいよねってお話。

以下の７つのことを意識するとだいぶソースが読みやすくなると思います！

1. 制御構文の前後の空白
2. {の直前の空白
3. ,カンマ区切りの後の空白
4. 演算子前後の空白
5. 三項演算子の適度な改行
6. 処理の切れ目で空行を入れる
7. コンストラクタ改行する

1. 制御構文の前後の空白

/**
 * □　ポイントとなる空白を表してます。
 * ↩︎ ポイントとなる改行を表してます。
 */


if□(true)□{

}□else□{

}

try□{

}□catch□(Exception e) {

}

switch□(num) {
    case 1:

    case 2:

    default:
}

2. {の直前の空白

public void hoge()□{

}

3. ,カンマ区切りの後の空白

public void hoge(String foo,□String bar) {

}

4. 演算子前後の空白

Parson parson□=□new Parson(String name, int age);

if (hoge□==□null) {
}

5. 三項演算子の適度な改行(これは結構好みありそう)

String str = (hoge == "hoge")↩︎
    ? "hoge"↩︎
    : "hogehoge";

6. 処理の切れ目で空行を入れる

直前の処理とやることが変わったり、意味合いが変わる場合は適度に空行を入れてあげましょう。
コードの塊を作ってあげると、初見の人にとって読みやすいコードになります。

7. コンストラクタ改行する(かなり好き嫌いあるでしょう...)

複数人でコード修正を行うときに、コンフリクトしづらくなるので、
私が加入している案件では採用されています。

public class hogeObject {
    hogeObject(String a,↩︎
               String b,↩︎
               String c,↩︎
               String d,↩︎
               String e,↩︎
               String f,↩︎
               String h,↩︎
               String i,↩︎
               String j) {
    }
}

異論は歓迎です！