一傀蚌、命名規(guī)范
項(xiàng)目名全部小寫(xiě)
包名全部小寫(xiě)
類名首字母大寫(xiě)蹦漠,如果類名由多個(gè)單詞組成戚嗅,每個(gè)單詞的首字母都要大寫(xiě)。
如:public class MyFirstClass{}變量名衍菱、方法名首字母小寫(xiě)赶么,如果名稱由多個(gè)單詞組成,每個(gè)單詞的首字母都要大寫(xiě)脊串。如:
int index=0;
public void toString(){}
- 常量名全部大寫(xiě)如:
public static final String GAME_COLOR="RED";
- 所有命名規(guī)則必須遵循以下規(guī)則:
1)辫呻、名稱只能由字母、數(shù)字琼锋、下劃線放闺、$符號(hào)組成
2)、不能以數(shù)字開(kāi)頭
3)缕坎、名稱不能使用JAVA中的關(guān)鍵字雄人。
4)、堅(jiān)決不允許出現(xiàn)中文及拼音命名念赶。
二、注釋規(guī)范
- 類注釋
在每個(gè)類前面必須加上類注釋恰力,注釋模板如下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 類的詳細(xì)說(shuō)明
*
* @author 類創(chuàng)建者姓名
* @Date 創(chuàng)建日期
* @version 1.00
*/
- 屬性注釋
在每個(gè)屬性前面必須加上屬性注釋叉谜,注釋模板如下:
/** 提示信息 */
private String strMsg = null;
- 方法注釋
在每個(gè)方法前面必須加上方法注釋,注釋模板如下:
/**
* 類方法的詳細(xì)使用說(shuō)明
*
* @param 參數(shù)1 參數(shù)1的使用說(shuō)明
* @return 返回結(jié)果的說(shuō)明
* @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說(shuō)明
*/
- 構(gòu)造方法注釋
在每個(gè)構(gòu)造方法前面必須加上注釋踩萎,注釋模板如下:
/**
* 構(gòu)造方法的詳細(xì)使用說(shuō)明
*
* @param 參數(shù)1 參數(shù)1的使用說(shuō)明
* @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說(shuō)明
*/
- 方法內(nèi)部注釋
在方法內(nèi)部使用單行或者多行注釋停局,該注釋根據(jù)實(shí)際情況添加。如:
//背景顏色
Color bgColor = Color.RED