java 不易注意的编程规范

除了非常常规的对齐缩进驼峰命名等格式规范，这里讲解一些大家不易注意的格式规范

idea 中自动调整页面规范 Ctrl + Alt + L

编码规范

1. 类名和{之间要隔着一个空格，方法也是如此

   class Test {
   }
   

2. 像== = + - * / %类似的运算符，变量和运算符之间加上一个空格，但是++和变量之间不加空格

   1 + 1
   

3. 循环语句 if 和( 之间需要加上一个空格，然后和{之间也有一个空格

   if (a == 1) {
   }
   

4. 方法中每个形参距离前一个,一个空格，方法后离{一个空格

   public void fun(int a, int b) {
   }
   

5. 若 if 下只有一条语句也建议加上{}

   if (count < 0) {
   	throw new StringIndexOutOfBoundsException(count);
   }
   

注释规范

1. 请勤加程序注释！
2. 类上需要加类注释，方法上需要加方法注释
3. 类上注释，关于类的描述和 @ 注释之间加一行隔开，方法注释也是如此

   /**
    * 描述
    *
    * @author abcnull
    * @see java
    */
    class Test {
    }
   

4. 类和方法注释中 @ 的注释部分，后面的数据可以全部对齐，如下：
   
   也可以同一类型的对齐：
   但是同一类型中和值的最近距离仍是一个空格
   
5. 静态块上建议加上/**/注释方式

   /*
    * 描述
    */
   

6. 类成员变量也需要加如下注释

   /**
    * 描述
    */
   

7. 代码中的注释建议用双斜杠，并且双斜杠和后面的语句隔着一个空格

   // 描述
   

8. 类和方法注释中不支持 @ 注释不要随意加，支持的有 author，version，date，see，since，deprecated 等