Java編程規范

jopen 9年前發布 | 31K 次閱讀 Java編程規范 Java開發

1.If for while等語句的執行語句不管有多少都要加上{}

2.相對獨立的程序塊之間,必須要有空行。

public void fun(int i) {
    System.out.println(i);
}

int index;</pre>

3.對齊只使用空格鍵不使用TAB鍵(因為不同編輯器tab鍵空格數可能不同)

4.在兩個以上的關鍵字、變量、常量進行對等操作時,他們之間的操作符之前、之后度需要加空格。

 Java編程規范

 Java編程規范

5.將注釋與其上面的代碼用空行隔開

 Java編程規范

6.對變量的定義和分支語句(條件分支、循環語句等)必須添加注釋。

7.邊寫代碼邊注釋,修改代碼的同時修改相應的注釋,以保證注釋與代碼的一致性。沒用的注釋要刪掉。

8.避免在注釋中使用縮寫,使用縮寫時,應對縮寫進行必要的說明。

9.屬性名和方法名不能相同,都使用駝峰格式,且方法名最好使用動賓結構,或動詞。

10.常量名使用全大寫,英文單詞之間使用下劃線分開

11.含有集合意義的屬性名,盡量包含其復數的意義。

12.所有的數據類必須重載toString()方法,返回該類有意義的內容。

13.明確方法功能,精確地實現方法設計,一個函數僅僅完成一個功能,即使簡單的功能也應該另寫方法實現。這樣可以增加程序的可讀性。

14.明確類的功能,精確地實現類的設計。一個類僅實現一組相近的功能 。(說明:劃分類的時候,應盡量把邏輯處理、數據和顯示分離,實現類功能的單一性。) 數據類不包含數據處理邏輯; 通信類不包含顯示處理的邏輯。

15.異常捕獲后,如果不對該異常進行處理,則應記錄日志。

16.自己拋出的異常必須填寫詳細的描述信息。

17.避免使用不易理解的數字,用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量,不應該直接使用數字,必須用有意義的靜態變量來代替。

18.數組聲明的時候使用int[] array, 而不要使用int array[].可讀性問題

19.調試代碼的時候,不要使用system.out或system.err進行打印,應該使用一個包含統一開關的測試類進行統一打印。 說明:代碼發布的時候可以統一關閉調試代碼,定位問題的時候又可以打開開關。

20.記錄異常不要保存exception.getMessage(),而要記錄exception.toString()。

21.一個方法不應該拋出太多類型的異常

說明:如果程序中需要分類處理,則將異常根據分類組織成繼承關系。如果確實有很多異常類型首先考慮異常描述來區別,throws/exception子句標明的異常最好不要超過三個。

22.異常捕獲盡量不要直接catch(Exception e),應該把異常細分處理

23.如果多段代碼重復做同一件事情,那么在方法的劃分上可能存在問題。

說明:若此段代碼各語句之間有實質性關聯并且是完成同一個功能的,那么可以考慮把此段代碼造成一個新的方法。

24.把main()方法放到類的最后,聲明方法違例的時候不要使用Exception,應該使用他的子類。

25.不要直接扔出一個Error,應該扔出它的子類。

26.盡量不要使用內部類

27.一個sql語句使用到多張表時要記著使用別名,字段要記住用表名調用如下

user.password

28.Import不要使用通配符:不要出現類似這樣的import語句:import java.util.*;

29.類的排序

類的成員順序對易學性有很大的影響,但這也不存在唯一的通用法則。不同的類對成員的排序可能是不同的。 最重要的一點,每個類應該以某種邏輯去排序它的成員,維護者應該要能解釋這種排序邏輯。比如, 新的方法不能總是習慣性地添加到類的結尾,因為這樣就是按時間順序而非某種邏輯來排序的。 當一個類有多個構造函數,或是多個同名方法,這些函數/方法應該按順序出現在一起,中間不要放進其它函數/方法。

30.每次之聲明一個變量:不要使用組合聲明,比如int a, b;。

31.中括號是類型的一部分:String[] args, 而非String args[]。

32.花括號前空一格,條件語句if while后有空格

33.Static在final前面

來自: http://leihuang.org/2015/07/02/java-coding-specification

 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!