JAVA编程规范

一、命名规范

1、 全部小写—— 项目名、包名

2、首字母大写——类名如：public class MyFirstClass{}

4、 首字母小写—— 变量名、方法名如：int index=0;  public void toString(){}

5、全部大写——  常量名如：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

*   关联类      :

*                通用DAO：CommonDAO;

*                领域对象：Project;

*   处理流程    :

*               

*   调用示例    :

*               

*   ----------------------------------------------------------

*   时间:               修改者:

*   修改内容：

*

 

 

 */

 

2、   属性注释

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

/** 提示信息 */

private String strMsg = null;

 

3、   方法注释

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

/**

*方法名

 * 类方法的详细使用说明

 *

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

 * @return 返回结果的说明

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

 */

4、   构造方法注释

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

/**

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

 *

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

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

 */

 

5、   方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：//背景颜色

       Color bgColor = Color.RED;

     6、jsp注释

          采用HTML注释进行注释，对于使用标记库的循环如forEach需要在开始和结束时进行注释

<!—开始循环显示projectList-->

<c:forEach items=”projectList” var=”project”>

</c:forEach>

<!—结束循环-->