Java项目命名规范

一.命名规范

1.项目名 - 全部小写

2.包名- 全部小写（包名命名规范）

3.类名 - 每个单词的首字母大写

public class FrameGame{}

4.变量名、方法名 - 首字母大写，如果名称由多个单词组成，每个单词的首字母都要大写。

int index = 0;

float myPrice = 1234;

public void toString(){}

5.常量名 - 全部大写、单词之间使用_进行连接

public static final int SIZE = 7;

public static final String GAME_COLOR = "RED"

二.注释规范

1.类

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名
    * @Date    创建日期

* @version 1.00

*/

2.属性注释

/** 提示信息 */

private String strMsg = null;

3.方法注释

/**

* 类方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @return 返回结果的说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4.构造方法注释

/**

* 构造方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5.方法内语句注释

//背景颜色

Color bgColor = Color.RED