Java命名规范与注释规范

一、命名规范

1、项目（工程）名：全部小写；

2、包名：全部小写；

3、类名：首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写；

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

5、常量名：全部大写；

6、所有命名规则必须遵循以下规则：

1)、名称只能由字母、数字、下划线、$符号组成

2)、不能以数字开头

3)、名称不能使用JAVA中的关键字

二、注释规范

1、类注释

在每个类前面必须加上类注释，注释模板如下：

/**

* 类的详细说明

*

* @author 创建者姓名

* @Date 修改日期

* @version 0.5

* @Date 修改日期

* @version 1.00

* ...

*/

2、属性注释

在每个属性前面必须加上属性注释，注释模板如下：

/** 属性说明 */

3、方法注释

在每个方法前面必须加上方法注释，注释模板如下：

/**

* 方法的详细说明

*

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

* @param 参数2 参数2的说明

* ...

* @return 返回结果的说明

* @exception 异常类型1 抛出该异常的说明

* @exception 异常类型2 抛出该异常的说明

* ...

*/

4、方法内部注释

在方法内部根据实际情况使用单行或者多行注释，一般使用单行注释"//"。