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