JAVA開發規範

基本原則
便於自己開發,增加代碼的可讀性,代碼風格前後一直,並且在不同編輯器中風格一致
     縮進
代碼中以4個字符作爲縮進[一個Tab],但應使用空格來代替Tab,以免再不同編輯器設置下導致Tab長度不等而影響整個程序代碼的格式
     長度
單個函數的長度不宜超過一個屏幕,單個類的長度不宜超過1500行。
     行長度
儘量避免一行的長度超過120個字符。當一個表達式無法容納在一行時,可以按如下規則斷開:
1:在一個逗號後面斷開
2:在一個操作符前面斷開
3:選擇高級別的斷開,而非較低級別的斷開
4:新的一行應該與上一行同一級別表達式的開頭處對齊
5:如果以上規則導致代碼混亂或者使代碼都堆擠在右邊,那就代之以縮進8個空格
if語句的換行採用8個空格的規則,常規4個空格的換行會使代碼看起來比較費勁
代碼編寫完成後採用快捷鍵"ctrl+shift+F"格式化代碼
     編碼
所有java代碼都必須使用UTF-8格式
     包命名
一個唯一包名的前綴總是全部小寫字母冰球是一個頂級域名
 類命名
類命必須是名詞,並且每個單詞的首字母必須是大寫,其餘小寫
 變量命名
首字母小寫,其他單詞首字母大寫
 常量命名
1:常量所有字母大寫,並且使用下劃線_分割單詞
2:儘量避免使用常量,而採用方法進行獲取常量
 方法命名
方法名必須是動詞,並且以小寫字母作爲首字母
 特殊命名規範
1:必須使用get/set訪問類屬性
2:Boolean變量和方法使用is前綴
3:對象初始化方法可以使用init前綴
4:提供查找的方法可以使用find前綴
5:提供計算的方法可以使用compute前綴
6:聲明集合對象時使用複數形式
7:表示對象個數的變量可以使用n前綴
8:遍歷使用變量儘量爲i/j/k
9:對應的名稱儘量成對使用,比如get/set、add/remore、start/stop...
10:異常類必須以Exception結尾
 註釋
註釋是需要的,但頻繁的註釋有時反映出代碼的低質量,通常應避免那些代碼更新就可能過時的註釋。如果當你覺得被迫需要加註釋時可以考慮重寫代碼以使其清晰。避免提供代碼能夠清晰表達的出來的信息。註釋不應寫在用星號或者其他字符畫出來的大框裏,不應包括諸如製表符和回退符之類的特殊字符。
 包的引用
import引用的類必須顯示的指明,而不能使用諸如import java.util.*代替
 變量聲明
儘可能在變量聲明時將變量初始化,並且保證變量的有效範圍儘可能的小!
 循環
避免使用do-while
循環變量應該在循環前初始化
 其他
1: 任何情況下都不要省略{}
2: 不同的邏輯單元語句之間使用空行分開
3: 常量數字使用變量聲明,而不是直接寫
 private static final int TEAM_SIZE=10;
 Player[] players=new Player[TEAM_SIZE];// not Player[] players=new Player[10]
4:浮點數應該永遠都包含一個小數點和小數,並且小數點前面應該有一個數字
5:程序中的System.out.print必須取消掉
6:禁止使用float和double進行金額的運算,必須使用java.math.BigDecimal對金額進行運算。在浮點數和String中建議使用String表示金額。BigDecimal(double d)和BigDecimal(String str)二者中強烈建議選擇後者,因爲前者的結果存在一些不可預知結果,仍然沒有達到精確計算的精算。如果需要對運算的結果按照約定的小數位數進行舍入,必須使用Java.math.BigDecimal.setScale(約定小數位數,RoundingMode.HALF_UP)
儘可能使用String表示金額,會少很多麻煩
 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章