Java~命名規範

下面總結以點java命名規範

雖然感受這些規範比起C#來講有點怪,但仍是應該尊重它的命名!java

命名規範

  1. 項目名所有小寫
  2. 包名所有小寫
  3. 類名首字母大寫,若是類名由多個單詞組成,每一個單詞的首字母都要大寫。
  4. 變量名、方法名首字母小寫,若是名稱由多個單詞組成,每一個單詞的首字母都要大寫。
  5. 常量名所有大寫
  6. 全部命名規則必須遵循如下規則:
    . 名稱只能由字母、數字、下劃線、$符號組成
    . 不能以數字開頭
    . 名稱不能使用JAVA中的關鍵字。
    . 堅定不容許出現中文及拼音命名。

註釋規範

1 類註釋

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

/**
* 類的詳細說明
*
* @author 類建立者姓名
* @Date    建立日期
*   @version 1.00
*/
2 屬性註釋

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

/** 提示信息 */
private String strMsg = null;
3 方法註釋

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

/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 註明今後類方法中拋出異常的說明
*/
4 構造方法註釋

在每一個構造方法前面必須加上註釋,註釋模板以下:模板

/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 註明今後類方法中拋出異常的說明
*/
5 方法內部註釋

在方法內部使用單行或者多行註釋,該註釋根據實際狀況添加。class

//背景顏色
int init =1;

待續...變量

相關文章
相關標籤/搜索