[Java] 我的Coding Style 總結

標籤：bre   final   成員變數   否則   9.png   換行   複數   har   釋放   

1. 縮排

採用4個空格的縮排方式

2. tab

不採用"hard" tab。 需要更改編輯器的預設配置。將tab值改成4個空格。

3. 換行

3.1 一行不超過75個字元

3.2 如果太長，可以在：

• • 　“,” 後換行
  • 　運算子前換行

4. 空格

　　4.1.在關鍵字和（）之間加空格， 如： while ()

　　4.2. 運算子前後加空格

　　4.3. 在參數列表的“,”後加空格， 如： test(int id, string name)

　　4.4. 強制轉換類型後加空格， 如： (object) x

5. 括弧

　　不省略大括弧和小括弧

6. 空行

　　6.1. 匯入的包之後加空行

　　6.2. 兩個方法之間加空行

　　6.3. 局部變數和該方法中第一個邏輯語句之間加空行

　　6.4. if, while, for等 控制語句之前加空行

　　6.5. 行注釋前加空行

7. 命名

　　7.1. 最重要的是要meaningful 

　　7.2. 不使用生僻的單詞

　　7.3. 太長的方法名， 可能是包含了多個功能，可以嘗試拆分方法

　　7.4. 縮寫時，建議把母音帶上， 如message => MSG

　　7.5. 駝峰命名法。

　　7.6. 常量： 需要全大寫， 單詞與單詞之間加"_".

　　7.7. 包： 單詞中的每個字母都小寫 例如: java.lang

　　7.8. 類的命令： 單詞需是名詞， 並且首字母大寫

　　7.9. 介面： 單詞需是名詞， 並且首字母大寫

　　7.10. 方法：單詞需是動詞, 並且首字母小寫

　　7.11. 集合數組： 名字需是複數

　　7.12. 不重要的，臨時變數： 採用標準名詞， 如 Object o, Exception e, character c, d, e

8. 注釋

　　8.1. 類和方法的注釋一定要有。

　　8.2. 去除無用的comment, 通過變數名就可以瞭解含義

　　8.3. 如果有特殊的代碼塊，容易引起誤解的，需要加註釋。

　　8.4. 如果有多層迴圈， 可以在迴圈體的尾部加註釋， 如//end while

　　8.5. 如果在switch中使用了fall through, 則需要加註釋， 否則， 通常是要加break;

9. 其它

　　9.1. 類成員變數：需採用get, set 方法讀取，設定

　　9.2. 重要的或重複的運算式或者方法應該提取出來。

　　9.2. 異常處理： 不忽略任何的異常資訊。 如果要追蹤更進階的異常， 不要忽略低層級的異常資訊。

　　9.3. 釋放資源：如果有需要釋放資源， 需要放入finally塊中。

 

其他參考：

http://www.oracle.com/technetwork/java/codeconvtoc-136057.html

http://www.infoq.com/news/2014/02/google-java-coding-standards/

 

[Java] 我的Coding Style 總結