Java命名規範java
1、命名規範spa
一、 項目名所有小寫io
二、 包名所有小寫模板
三、 類名首字母大寫,若是類名由多個單詞組成,每一個單詞的首字母都要大寫。class
如:public class MyFirstClass{}變量
四、 變量名、方法名首字母小寫,若是名稱由多個單詞組成,每一個單詞的首字母都要大寫。方法
如:int index=0;命名
public void toString(){}項目
五、 常量名所有大寫異常
如:public static final String GAME_COLOR=」RED」;
六、全部命名規則必須遵循如下規則:
1)、名稱只能由字母、數字、下劃線、$符號組成
2)、不能以數字開頭
3)、名稱不能使用JAVA中的關鍵字。
4)、堅定不容許出現中文及拼音命名。
2、註釋規範
一、 類註釋
在每一個類前面必須加上類註釋,註釋模板以下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 類的詳細說明
*
* @author 類建立者姓名
* @Date 建立日期
* @version 1.00
*/
二、 屬性註釋
在每一個屬性前面必須加上屬性註釋,註釋模板以下:
/** 提示信息 */
private String strMsg = null;
三、 方法註釋
在每一個方法前面必須加上方法註釋,註釋模板以下:
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 註明今後類方法中拋出異常的說明
*/
四、 構造方法註釋
在每一個構造方法前面必須加上註釋,註釋模板以下:
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 註明今後類方法中拋出異常的說明
*/
五、 方法內部註釋
在方法內部使用單行或者多行註釋,該註釋根據實際狀況添加。
如://背景顏色
Color bgColor = Color.RED