java 中通用規範

駝峯命名法:駝峯命名法就是當變量名或函數名是由一個或多個單字連結在一起,而構成的一識別字時,第一個單字以小寫字母開始,第二個單字的首字母大寫或每一個單字 的首字母都採用大寫字母例如:myFirstProject。

1 java命名規範

1.1 項目名

  • 一部分人採用簡寫,然後全部大寫
  • 一部分人使用首字母大寫+駝峯命名法

1.2 包名:[全部小寫,域名起頭]

  • 包名全部小寫;
  • Package第一部分通常是頂級域名之一,如com、edu、gov、mil、net、org,後續部分由各組織內部命名規則決定,內部命名規則 指定了各組件的目錄名,所屬部名,項目名等。例如:com.frontfree.javagroup;

關於j2ee中包的命名習慣,我在網上看到一篇博客,很詳細的彙總了j2中各個方面包的命名規範,給大家個網址:http://blog.csdn.net/yilvqingtai/article/details/7989618

1.3 類名:[首字母大寫+駝峯命名法]

根據約定,Java類名通常以大寫字母開頭,如果類名稱由多個單詞組成,則每個單詞的首字母均應爲大 寫例如TestDemo;如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應大寫,例如DOMDemo。

1.4 接口:[首字母大寫+駝峯命名法]

  • 接口名的命名規範與類名一致;
  • 使用完整的英文描述命名接口。

1.5 方法:[駝峯命名+顧名思義]

  • 首字母小寫,其他單詞首字母大寫,如:getName();
  • 使用完整的描述來準確描述方法名,看到方法名就該知道這個方法的功能,例如:getNameByIdFromDB() 一看就知道是通過id 從數據庫中獲取name,雖然有點長,但 對後期理解和維護提供了極大方便,當然,爲了防止代碼冗長,還是應該儘量縮短名稱長度,可以使用縮寫的地方儘量使用縮寫;
  • 方法名應該是一個動詞+名詞,例如getName();
  • 前綴問題
    I:類的獲取方法(有返回值的方法)的方法名一般加前綴get,如:getRootNode();
    II:類的布爾型判斷方法一般以is爲前綴,如isEmopty();
    III:類的設置方法加前綴set,如setName();
    IV:一般方法,使用完整的英文描述說明方法功能,以單詞開頭,如:openFile();

1.6 方法的參數:

  • 使用有特定意義的詞定義方法參數,如果可能的話使用與被賦值變量相同的名字;
  • 首字母小寫,其他單詞首字母大寫

1.7 普通變量:[駝峯命名+顧名思義+前綴]

  • 採用駝峯命名;
  • 變量名要儘量簡短,並且可以顧名思義,避免使用a,b,c等;
  • 避免相似或只在大小寫上有區別,例如:flag和Flag,避免同時使用;
  • 循環計數變量使用i,j,k
  • 前綴問題:
    I:可以在變量名前加2到3個字母的前綴表示變量的數據類型,例如:strClassName(以此表示String型)、intStudentAge(表示int型)等等;
    II:可以通過加前綴區分全局變量和局部變量,用g_表示全局變量,如g_strClassName。鑑 於全局變量難以維護,應該盡少全局變量的使用。
  • 後綴問題:
    I:爲了創建統一的變量,通常在變量名後加一個量詞後綴,例如strStudentFirst,strStudentLast,而不要使用strFirstStudent常用的量詞後綴有First,Next,Prev,Last,Cur(一組變量中的當前變量)

1.8 靜態變量:[全部大寫,常加下劃線]

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

1.9 常量:[全部大寫,常加下劃線]

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

1.10 xml:

  • xml文件名全小寫;

1.11 jsp/js等普通文件:

  • 與class命名規則一致;’

版權聲明:本文爲CSDN博主「光光-Leo」的原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/u012116457/article/details/22582393

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章