Java命名規範與註釋規範

一、命名規範

1、項目(工程)名:全部小寫;

2、包名:全部小寫;

3、類名:首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫;

4、變量名、方法名:首字母小寫,如果名稱由多個單詞組成,每個單詞的首字母都要大寫;

5、常量名:全部大寫;

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

1)、名稱只能由字母、數字、下劃線、$符號組成

2)、不能以數字開頭

3)、名稱不能使用JAVA中的關鍵字


二、註釋規範

1類註釋

在每個類前面必須加上類註釋,註釋模板如下:

/**

* 類的詳細說明

*

* @author 創建者姓名

* @Date 修改日期

* @version 0.5

* @Date 修改日期

* @version 1.00

...

*/


2、屬性註釋

在每個屬性前面必須加上屬性註釋,註釋模板如下:

/** 屬性說明 */


3方法註釋

在每個方法前面必須加上方法註釋,註釋模板如下:

/**

* 方法的詳細說明

*

* @param 參數1 參數1的說明

* @param 參數2 參數2的說明

...

* @return 返回結果的說明

* @exception 異常類型1 拋出該異常的說明

* @exception 異常類型2 拋出該異常的說明

...

*/


4方法內部註釋

在方法內部根據實際情況使用單行或者多行註釋,一般使用單行註釋"//"


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