首頁  >  文章  >  Java  >  JAVA的程式碼規範

JAVA的程式碼規範

一个新手
一个新手原創
2017-10-10 09:32:391319瀏覽

一、命名規範

1、標識符:統一、達意、簡潔

  統一:一個字有多種表達方式,不求最好,但求統一;例:供應商,既可以用supplier,也可以用provider,選擇一種統一使用;

  達意:明確表達其意義,正確而且豐富;例:newSupplier與supplier1, service2的區別;

  簡潔:在統一與達意的前提下,進行簡潔;若不能達意,請放棄簡潔;

  駱駝法則:不使用特殊符號分割,而是透過首字母大寫來分割;例:SupplierName , addNewContract;

  英文與拼音:盡量使用簡單的英文或全部使用拼音,拒絕英文拼音混合使用;

2、套件名稱:小寫、連結

  包名稱:全部使用小寫;不使用特殊符號分割;

3、類別名稱

  類別名稱:首字母大寫,每個單字的大寫

  後綴:Service 、Impl、Inter、Dao、Action、listener、Event、Servlet、Factory、Job..

4、方法名稱

  方法名稱:首個字首小寫,後續字首大寫

  前綴:create、delete、add、remove、initialize、destroy、open、close、read、get、copy、modity、send、find..

二、空格空行

  空格使用(1個緊隨,2個為前後):分隔時1個;運算子2個;逗號1個;例:call(a, b, c);b - d = e;return a == b ? 1 : 0;if (a > b)

  空行使用:語意運算;方法之間;超十行;

三、程式碼註解

  程式碼混亂,再多的註解都不能彌補;達意+統一+簡潔+結構清晰==較少的註解

  註解:少而精;程式碼意義註解;非程式碼管理;svn的刪除時代

  單行時用//, 多行時用/* .. */;流程-包圍;流程-大括號;

#四、最佳實踐

  1、懶惰的程式設計師,每次儲存提交時,都要保持最優程式碼;每次儲存的必須為最美的程式碼;

  2、log更多的評級使得其優於println;

  3、if while for 後邊加括號;

  4、//TODO讓大家知道,你還有什麼沒做;

  5、用「;」或"//nothing ti do " 來說明你故意不需要做什麼;

  6、減少巢狀層次;減少true/false的判斷;減少變數的作用域;減少使用傳回結果的方法;變數宣告、初始化、使用盡量放在一起;

以上是JAVA的程式碼規範的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn