JAVA編程規範總結:
1.編碼規範好處:
1.減少維護成本和時間
2.增加可讀性,方便自己和維護的技術人員二次改善
3.提高開發效率,團隊協作
4.養成好習慣,提高自身修煉
2.命名規範:
1、儘量使用完整的英文描述符
3、採用大小寫混合使名字
4、儘量少用縮寫
5、避免使用長的名字(小於 15 個字母爲正常選擇)
6、避免使用類似的名字,或者僅僅是大小寫不同的名字
7、避免使用下劃線(除靜態常量等)
Package命名
Package 的名字應該採用完整的英文描述符,都是由一個小寫單詞組成,可以採用頂級域名 com、edu、gov、mil、net、org加上項目名加上功能名字
例如:com.net.ftp
類( Class )命名
類名應該是個一名詞,採用大小寫混合的方式,每個單詞的首字母大寫。
接口( Interface )命名
和類定義一樣,但是接口一般規範需要在前進加上大寫I和類區別開來(實現接口一般和類一樣,但是在末尾加上Impl)
枚舉( Enum )的命名
和類定義一樣,但是接口一般規範需要在前進加上大寫E區別開來
方法( Method )的命名
方法名是一個動詞,採用大小寫混合的方式,第一個單詞的首字母小寫,其後單詞的首字母大寫(駝峯形式)。方法名儘可能的描述出該方法的動作行爲。返回類型爲 Boolean 值的方法一般由“
is ”或“ has ”來開頭。
異常( Exception )的命名
異常( Exception )通常採用字母 e 表示異常,對於自定義的異常類,其後綴必須爲 Exception
參數( Param )的命名
第一個單詞的首字母小寫,其後單詞的首字母大寫(駝峯形式)
常量字段( Constants )的命名
靜態常量字段( static
final )全部採用大寫字母,單詞之間用下劃線分隔 例如:功能名_返回值
3.註釋規範(每個公司有每個公司規範,僅參考)
1.頭部/** */ 寫明版權信息以及該文件的創建時間和作者,修改內容修改時間等。
2.方法名需描述方法功能,參數屬性,參數含義,返回值,及其它任何約束或前提條件。
3.邏輯註釋,詳細寫明邏輯到底做什麼,得到什麼結果,返回什麼等。給後期人員提供參考
4.塊註釋用/** */,單行註釋用/* */和//。
5.爲了後期維護能很好理解和生成接口文檔,註釋文檔必須書寫在類、域、構造函數、方法,以及字段(field)定義之前。
6.javadoc註釋標籤語法
@author 對類的說明標明開發該類模塊的作者
@version 對類的說明標明該類模塊的版本
@see 對類、屬性、方法的說明參考轉向,也就是相關主題
@param 對方法的說明對方法中某參數的說明
@return 對方法的說明對方法返回值的說明
@exception 對方法的說明對方法可能拋出的異常進行說明
每層命名規範:
控制器Controller (動詞+名稱駝峯+Controller)
服務接口IService (I+動詞+名稱駝峯+Service)
服務層Service (動詞+名稱駝峯+ServiceImpl)
數據訪問接口IDAO (I+動詞+名稱駝峯+Dao)
總結不好多多擔待,文章只單純個人總結,如不好勿噴,技術有限,有錯漏麻煩指正提出。本人QQ:373965070