1.規(guī)范存在的意義：

好的編碼規(guī)范可以盡可能的減少一個軟件的維護成本 , 并且?guī)缀鯖]有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護；

好的編碼規(guī)范可以改善軟件的可讀性，可以讓開發(fā)人員盡快而徹底地理解新的代碼；好的編碼規(guī)范可以最大限度的提高團隊開發(fā)的合作效率；

長期的規(guī)范性編碼還可以讓開發(fā)人員養(yǎng)成好的編碼習(xí)慣，甚至鍛煉出更加嚴謹?shù)乃季S；

2.命名規(guī)范：

盡量使用完整的英文描述符

采用適用于相關(guān)領(lǐng)域的術(shù)語

采用大小寫混合使名字可讀

盡量少用縮寫，但如果用了，必須符合整個工程中的統(tǒng)一定義

避免使用長的名字（小于 15 個字母為正常選擇）

避免使用類似的名字，或者僅僅是大小寫不同的名字

避免使用下劃線（除靜態(tài)常量等）

所有Pojo類與數(shù)據(jù)庫表名對應(yīng)

所有Dao接口類繼承自BaseDao，以I打頭，以pojo類名稱+Dao結(jié)束

所有Daoimpl實現(xiàn)類以pojo類名稱+DaoImpl結(jié)束

所有業(yè)務(wù)接口類以I打頭，以業(yè)務(wù)名稱+Service結(jié)束

所有業(yè)務(wù)實現(xiàn)類：業(yè)務(wù)名稱+Service；

3.標識符類型說明：

包（ Package ）的命名:

采用完整的英文描述符，都是由一個小寫單詞組成

類（ Class ）的命名:

類名應(yīng)該是個一名詞，采用大小寫混合的方式，每個單詞的首字母大寫。盡量保證類名簡潔而富于描述。使用完整單詞，避免縮寫詞 ( 除非工程內(nèi)有統(tǒng)一縮寫規(guī)范或該縮寫詞被更廣泛使用

接口（ Interface ）的命名:

基本與 Class 的命名規(guī)范類似。在滿足 Classd 命名規(guī)則的基礎(chǔ)之上，保證開頭第一個字母為”I”，便于與普通的 Class區(qū)別開

枚舉（ Enum ）的命名

異常（ Exception ）的命名

方法（ Method ）的命名

在service中，操作數(shù)據(jù)庫更新、寫入、刪除，方法名以update、save、edit、add、move、delet、remove打頭，保證spring事務(wù)托管的有效；對數(shù)據(jù)的查詢采用 list、get、find打頭；

一般方法遵循：

方法名是一個動詞，采用大小寫混合的方式，第一個單詞的首字母小寫，其后單詞的首字母大寫。方法名盡可能的描述出該方法的動作行為。返回類型為 Boolean 值的方法一般由“ is ”或“ has ”來開頭例如：返回類型為 Boolean 值：用“ is ”或“ has ”來開頭

得到某數(shù)據(jù)： get+ 數(shù)據(jù)描述名詞復(fù)數(shù) + 數(shù)據(jù)類型；

得到所有數(shù)據(jù)： get+All+ 數(shù)據(jù)描述名詞復(fù)數(shù) + 數(shù)據(jù)類型；

通過 XXX 得到 / 查詢某數(shù)據(jù)： get/query+ 數(shù)據(jù)描述名詞復(fù)數(shù) + 數(shù)據(jù)類型 +By+ 條件；

添加某數(shù)據(jù)： save/add+ 數(shù)據(jù)描述名詞 ()

更新某數(shù)據(jù)： save/update+ 數(shù)據(jù)描述名詞；

刪除某數(shù)據(jù)： delete/remove+ 數(shù)據(jù)描述名詞；

參數(shù)（ Param ）的命名：

第一個單詞的首字母小寫，其后單詞的首字母大寫。參數(shù)量名不允許以下劃線或美元符號開頭，雖然這在語法上是允許的。參數(shù)名應(yīng)簡短且富于描述。

常量字段（ Constants ）的命名：

靜態(tài)常量字段（ static final ）全部采用大寫字母，單詞之間用下劃線分隔；

總結(jié)

以上是生活随笔為你收集整理的项目开发中的编码规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。