Java~命名規范
下面總結以點java命名規范
雖然感覺這些規范比起C#來說有點怪,但還是應該尊重它的命名!
命名規范
- 項目名全部小寫
- 包名全部小寫
- 類名首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫。
- 變量名、方法名首字母小寫,如果名稱由多個單詞組成,每個單詞的首字母都要大寫。
- 常量名全部大寫
- 所有命名規則必須遵循以下規則:
*. 名稱只能由字母、數字、下劃線、$符號組成
*. 不能以數字開頭
*. 名稱不能使用JAVA中的關鍵字。
*. 堅決不允許出現中文及拼音命名。
注釋規范
1 類注釋
在每個類前面必須加上類注釋,注釋模板如下:
/**
* 類的詳細說明
*
* @author 類創建者姓名
* @Date 創建日期
* @version 1.00
*/
2 屬性注釋
在每個屬性前面必須加上屬性注釋,注釋模板如下:
/** 提示信息 */
private String strMsg = null;
3 方法注釋
在每個方法前面必須加上方法注釋,注釋模板如下:
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/
4 構造方法注釋
在每個構造方法前面必須加上注釋,注釋模板如下:
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/
5 方法內部注釋
在方法內部使用單行或者多行注釋,該注釋根據實際情況添加。
//背景顏色
int init =1;
待續...
浙公網安備 33010602011771號