前一陣子在複習JAVA，搜到了基本的編碼規範，感覺很有實用，在此mark一下~
注：文章內容選自軟酷實驗室~~
JAVA編碼規範大致可以分爲7個部分：
命名規範
- 1、所有的標示符都只能用 ASCII 字母(A-Z 或 a-z)、數字(0-9)和下劃線“_”。
- 2、類名是一個名詞，採用大小寫混合的方式，每個單詞的首字母大寫。例如:Neeke。
- 3、方法名是一個動詞或動詞詞組，採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫。例如:setNeekeName(String neekeName)。
- 4、變量名第一個字母小寫，任何中間單詞的首字母大寫。變量名應簡短且可以顧名思義，易於記憶。例如:neekeName、neekeAddress。避免單個字符的變量名，除非是一次性的臨時變量。不能出現類似 a 等名稱的變量。
- 5、常量的聲明應該全部大寫，每個單詞之間用“_”連接。例如:final String WWW_INEEKE_CN = “www.ineeke.com”;
註釋規範
- 1、註釋儘可能使用“//”;對於所有的 javadoc 的註釋則使用“/* /”;而臨時對代碼塊 進行註釋儘量使用“/* */”。
- 2、所有的源文件都應該在開頭有一個註釋，其中列出文件名、日期和類的功能概述。
- 3、每個方法必須添加文檔註釋(類的 main()方法除外)。每個方法都要有註釋. 註釋內容爲
- 4、參數說明，如果一個類裏面的方法是由多個人完成的，每個方法註明是誰所寫。
- 5、每個屬性必須添加註釋。
- 6、註釋使用中文（視情況而定）。
縮進排版規範
- 使用 Eclipse 的源代碼的格式化功能完成代碼的縮進排版 – 快捷鍵:Ctrl+F。
文件名規範
- 1、一個 Java 源文件只能存儲一個 Java 類。
- 2、文件名與 Java 類名相同。
聲明規範
- 1、一行聲明一個變量。
- 2、不要將不同類型變量的聲明放在同一行。
- 3、只在代碼塊的開始處聲明變量。
- 4、所有的變量必須在聲明時初始化。
- 5、避免聲明的局部變量覆蓋上一級聲明的變量。
- 6、方法與方法之間以空行分隔。
語句規範
- 1、每行至少包 一條簡單語句。
- 2、在 return 語句中，返回值不使用小括號“()”括起來。
- 3、if語句總是用“{”和“}”括起來。
- 4、在 for 語句的初始化或更新子句中，避免因使用三個以上變量，而導致複雜度提高。
- 5、當 switch 的一個 case 順着往下執行時(因爲沒有 break 語句)，通常應在 break 語句的位置添加註釋。
- 6、while if for 等循環嵌套語句不能超過三層。
編程規範
- 1、提供對實例以及類變量的 public 或 private 訪問控制，儘可能不適用默認值或 protected 訪問控制。
- 2、避免用一個對象訪問一個類的靜態變量或方法。應該用類名代替。
- 3、避免在一個語句中給多個變量賦相同的值。
- 4、用於設置對象狀態的方法前綴必須是 set;用於檢索一個布爾類型對象狀態的方法前綴必須是 is，而用於檢索其他方法前綴必須是 get。
- 5、程序中應儘可能少使用數字(或字符)，儘可能定義靜態變量來說明該數字(或字符)的含義。程序中需要賦值或比較時，使用前面定義的靜態變量。在循環控制中例外。
- 6、所有的異常都向上拋。
