Java命名規範

1  命名規範

1.1 Package 的命名
package 名字應該都是由一個小寫單詞組成。在開頭爲相對應的域名的名稱,其後跟相應 的名字。
1.2 Class 的命名
Class 的名字施行駝峯標識,即如果由多個單詞組成則 每個單詞的第一個字母必須大寫,中間不能有任何非字母字符。測試類的命名,必須冠以後綴 Test,比如SomeClassTest
1.3 Interface 的命名
Interface 的命名同Class 的命名規則,但必須冠以前綴I  ,比如ISomeInterface,接口的實現 類則是去掉前綴I但添加後綴Impl,比如SomeInterfaceImpl
1.4 Class 變量的命名(Object 的命名)
變量的名字施行駝峯標識,即如果由多個單詞組成則每個單詞的第一個字母必須大寫,中間不能有任何非字母字符。意義不是太明確或不是太常用單詞組成成員變量必須生成 JavaDoc 註釋文檔。
/**
*  用戶賬號
**/
1.5 static final 變量的命名
static final 變量的名字應該都大寫,並指出完整含義。如:SYSTEM_NAME
1.6 數的命名
參數的名字必須和變量的命名規範一致。
1.7 組的命名
數組的命名必必須和變量的命名規範一致。需要注意的一點是數組的聲明必須如下:
String[] buffer; 而不應該是: String buffer[];
1.8 法的命名
方法命名通常以動詞打頭,第一單詞的首字母小寫,後面的單詞以大寫字母開頭。方法的 命名儘可能指出這個方法的功能是幹什麼的。測試類的測試方法命名必須以 test  打頭,比如 testSendMessage(..)
1.9 構造函數
構造函數它應該用遞增的方式書寫(參數多的寫在後面)。。
1.10 {}括號
第一個大括號不能單獨起一行,終止大括號與方法聲明的第一個字母對齊。
public String getUsername() {
       
return username;
}
 
1.11 註釋
註解註釋以”/*”開頭,以”*/結束,javadoc識別的註釋則需要以”/**”開 頭,以”*/結束,具體的解釋用//。
1.12 類與方法註釋格式
類註釋
/**
 * * 客戶信息
 *
 * @Written by : zhanghongxin
 * @Creation Date : Jul 29, 2011 11:31:17 AM
 * @version : v1.00
 * @Description :
 *
 * @ModificationHistory Who When What -------- ----------
 *                      ------------------------------------------------
 *                      zhanghongxin Jul 29, 201111:31:17 AM TODO
 *
 **
*/
方法註釋
/**
    * @Written by : zhanghongxin
    * @Creation Date : Jul 29, 2011 7:02:45 PM
    * @version : v1.00
    * @Description : 跳轉客戶信息新建頁面*
    * @param req
    * @return
    *
  */
 
 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章