スタイルに関する規約

4.スタイルに関する規約

スタイルに関する規約は直接プログラムの動作に影響することはありませんが、可動性を向上させるだけでなく、チーム全体で統一した記述をすることにより他人の書いたプログラムでもすぐに読むことができるようになるため、非常に重要な規約です。

4.1.インデントの文字数と表記方法

ソース内で記述するインデントは 4 文字とします。また、タブを利用したインデントは不可とします。タブサイズは環境によってまちまちであったりすることが多く、環境が変わったときにソースの見え方が異なってくる可能性が高いため、インデントはすべて半角スペースで 4 文字分をとることとします。

public class test{
    public static void main(String[] args){
        System.out.println("test");
    }
 ↑ここの部分をタブではなく半角スペースにする。
}

4.2.ブロックの表記について

if 文、for 文、while 文などを利用する際のブロック表記については以下の記述に統一します。またこれはメソッドやクラスの書き方でもあります。

if(true){
    System.out.println("test");
}

for(int i = 0; i < list.size(); i++){
    System.out.println("test");
}

while(true){
    System.out.println("test");
}

次のような書き方は Java 言語としては表記可能ですが、すべてコーディング規約違反とします。

if(true) System.out.println("test"); 

for(int i = 0; i < list.size(); i++)
    System.out.println("test");

public void check(String item)
{
    System.out.println("test");
}

4.3.演算子の位置をそろえる

変数の宣言などが連続するコーディングをする場合、演算子をそろえて記述するとソースの可読性が良くなります。

public class Test{

    private static final String ERROR_MESSAGE           = "Error";
    private static final String DB_ACCESS_ERROR_MESSAGE = "DbAccessError";
    private static final int LOOP_COUNT                 = 1;
                                                       ↑
                                                       ここをそろえると非常に見やすくなります。
}

---