java命名規範法則大全(讓你的代碼更加專業化)

前言:我相信,我們在剛開始學習java的時候,給包、類、方法等命名的時候總是取名不規範。這雖然不是什麼大問題,但對於一個專業的程序員來說。命名規範化也是必不可少的。這裏給大家整理了一些命名法則,非常適合咱們這些萌新☆⌒(*^-゜)v THX!!

命名規範的話能夠在編碼過程中實現規範化,爲以後的程序開發中養成良好的行爲習慣。增加代碼的易讀性,可讀性。

一、包(全部小寫)

包名全部小寫,但它不同的項目類型:
1.個體項目(indi ): 如:indi.發起者名.項目名.模塊名.……

2.個人項目(pers): 如:pers.個人名.項目名.模塊名.……

3.私有項目(priv ): 如:priv.個人名.項目名.模塊名.……

4.團隊項目(team): 如:team.團隊名.項目名.模塊名.……

5.公司項目( com / cn / net / org / edu): 如下:
包名爲“com.公司名.項目名.模塊名.……”。

二、類(帕斯卡命名法)

1.Java類名通常以大寫字母開頭,如果類名稱由多個單詞組成,則每個單詞的首字母均應爲大 寫例如UserManager;

2.如果類名稱中 包含單詞縮寫,則這個所寫詞的每個字母均應大寫, 例如DOMDemo。

3. 還有一點命名技巧就是由於類是設計用來代表對象的,所以在命名類時應儘量 選擇名詞,如:Person(名詞)Chinese(形容詞)

4.POJO類(也就是實體類entity)
命名規範:具有含義的名字,如果有多個單詞,每個單詞頭字母大寫。一般和數據庫的表照應。
例如:user_info表 則POJO類爲UserInfo.

5.接口類
命名規範:業務邏輯接口實現類的命名以POJO名稱來制定,並且以大寫字母"I"開頭,如果有多個單詞,每個單詞頭字母大寫
例如:IUserInfo

6.接口實現類
命名規範:業務邏輯接口實現類的命名以POJO名稱來制定,將實現的接口名稱的首字母"I"去掉,以"Impl作爲結尾",如果有多個單詞,每個單詞頭字母大寫。
例如:UserInfoImpl

三、方法(駝峯命名)

1.首字母小寫,其他單詞首字母大寫,如:getName();

2.使用完整的描述來準確描述方法名,看到方法名就該知道這個方法的功能,例如:getNameByIdFrom表名() 一看就知道是通過id 從數據庫中獲取name

3. 儘量不去使用連接符 _

4.方法名應該是一個動詞+名詞,例如getName();

5.前綴問題
1:類的獲取方法(有返回值的方法)的方法名一般加前綴get,如:getName();
2:類的布爾型判斷方法一般以is爲前綴,如isTrue();
3:類的設置方法加前綴set,如setName();
4:一般方法,使用完整的英文描述說明方法功能,以單詞開頭,如:openFile();

四、方法參數

1.使用有特定意義的詞定義方法參數,如果可能的話使用與被賦值變量相同的名字;
如果參數需要區分和局部變量不重名的情況,則可以考慮加上Param
例如:userNameParam
2.首字母小寫,其他單詞首字母大寫

五、普通變量(駝峯命名+前綴)
1.採用駝峯命名;

2.變量名要儘量簡短,並且可以顧名思義,避免使用a,b,c等;

3.避免相似或只在大小寫上有區別,例如:flag和Flag,避免同時使用;

4.循環計數變量使用i,j,k

5.前綴問題:
1:可以在變量名前加2到3個字母的前綴表示變量的數據類型,例如:strClassName或者classNameStr (以此表示String型)、intStudentAge或者studentAgeInt (表示int型)等等;

2:可以通過加前綴區分全局變量和局部變量,用g_表示全局變量,如g_strClassName。鑑 於全局變量難以維護,應該盡少用全局變量。

五、靜態變量(全部大寫,常加下劃線)

1.全部大寫,單詞間用"_"連接,例如 static int THREAD_FLAG
其他規則參照普通變量的規則2,3,5

六、常量 (全部大寫,常加下劃線)

1.全部大寫,單詞間用"_"連接;
2.常量本身要用有意義的單詞定義;

七、所有命名規則必須遵循以下規則:

1.名稱只能由字母、數字、下劃線、$符號組成
2.命名時不能以數字開頭
3.在命名是絕對不能出現Java關鍵字
4.絕對不允許在命名時出現中文
5.儘可能的少用拼音性的命名

希望能幫到大家~

發佈了19 篇原創文章 · 獲贊 249 · 訪問量 1萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章