Java代码注释规范

一、 规范存在的意义

    应用编码规范对于软件本身和软件开发人员而言尤为重要，有以下几个原因：

1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；

2、好的编码规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码；

3、好的编码规范可以最大限度的提高团队开发的合作效率；

4、长期的规范性编码还可以让开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维；

二、命名规范

1、一般概念

1、尽量使用完整的英文描述符

        2、采用适用于相关领域的术语

        3、采用大小写混合使名字可读

        4、尽量少用缩写，但如果用了，必须符合整个工程中的统一定义

        5、避免使用长的名字（小于15个字母为正常选择）

        6、避免使用类似的名字，或者仅仅是大小写不同的名字

        7、避免使用下划线（除静态常量等）

2、标识符类型说明

1、包（ Package ）的命名

            Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名，通常是 com、edu、gov、mil、net、org 等；

            如： com.cfwx.test

2、类（ Class ）的命名

            类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用，像 URL ， HTML)

        如： FileDescription

3、接口（ Interface ）的命名

            基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”I”，便于与普通的 Class区别开。其实现类名称取接口名的第二个字母到最后，且满足类名的命名规范；

        如： IMenuEngine

4、枚举（ Enum ）的命名

            基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”E” ，便于与普通的 Class区别开。

        如： EUserRole

5、异常（ Exception ）的命名

            异常（ Exception ） 通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception

        如： BusinessException

6、方法（ Method ）的命名

            方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头

        如： getCurrentUser()、addUser()、hasAuthority()

7、参数（ Param ）的命名

            第一个单词的首字母小写，其后单词的首字母大写。参数量名不允许以下划线或美元符号开头，虽然这在语法上是允许的。参数名应简短且富于描述。

        如： public UserContext getLoginUser(String loginName);

8、常量字段 （ Constants ）的命名

            静态常量字段（ static final ） 全部采用大写字母，单词之间用下划线分隔；

        如： public static final Long FEEDBACK;

          public static Long USER_STATUS;

三、注释规范

一个很好的可遵循的有关注释的经验法则是：

            问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，你需要一些什么信息？？？

1、 一般概念

1、注释应该增加代码的清晰度

2、保持注释的简洁

3、在写代码之前或同时写注释

 4、注释出为什么做了一些事，而不仅仅是做了什么

2、 注释哪些部分

1、Java 文件：必须写明版权信息以及该文件的创建时间和作者；

2、类：类的目的、即类所完成的功能，以及该类创建的时间和作者名称；多人一次编辑或修改同一个类时，应在作者名称处出现多人的名称；

3、接口： 在满足类注释的基础之上，接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释；

4、方法注释： 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索；

 5、方法内部注释：控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释；

 6、参数： 参数含义、及其它任何约束或前提条件；

 7、属性： 字段描述；

 8、局部 ( 中间 ) 变量： 无特别意义的情况下不加注释；

3、 代码注释规范

1、单行注释：   

// 注释内容

2、块注释：

/**

* 注释内容

*/

3、类注释：

/**

*Description :       类名

* Author：          <作者中文名或拼音缩写>                

* Create Date：   <创建日期，格式:YYYY-MM-DD>

* Modified By：   <修改人中文名或拼音缩写>                                        

* Modified Date:  <修改日期，格式:YYYY-MM-DD>                                   

* Version:             <版本号>                      

*/

4、方法注释：  

/**

* Description :        描述 

* @param schema： 模式名

* @param name：    名称

* @param type：    数据源类型

*/

四、工程特有命名规范

1、持久层

1、Hibernate 映射文件及实体

       与数据库表名称完全对应；

       如： Advertisement.hbm.xml 、 Advertisement.java

2、数据访问 DAO

       DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则，且最后以 ”DAO” 结尾。DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操作；

如： ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )

3、各种操作数据库的 HQL 配置文件

      HQL 文件的个数原则上与系统的 Services 层的服务个数相等，且以服务名称命名 HQL 文件；

       如： resource.hbm.xml

2、服务层

 1、服务接口和实现

      服务接口和实现类必须完全符合正常接口和实现类的命名规则；以工程定义的服务名为主体，并统一以 ”Serv” 结尾

       如： IResourceServ( 服务接口 ) 、 ResourceServ( 接口实现类 )

2、服务接口方法

      方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

       方法名尽可能的描述出该方法的动作行为。

       返回类型为 Boolean 值：用“ is ”或“ has ”来开头

       得到某数据： get+ 数据描述名词复数 + 数据类型；

       得到所有数据： get+All+ 数据描述名词复数 + 数据类型；

       通过 XXX 得到 / 查询某数据： get/query+ 数据描述名词复数 + 数据类型 +By+ 条件；

       添加某数据： save/add+ 数据描述名词 ()

       更新某数据： save/update+ 数据描述名词；

       删除某数据： delete/remove+ 数据描述名词；

3、业务对象

       业务名称 +BO

4、查询参数对象

       凡是继承 Abst***QuerySpec 的查询参数类全部满足以下规则：

       Query+ 所要查询的数据描述名词 +Spec

       作为参数传入时，参数名必须为：所要查询的数据描述名词 +Spec

       如： QueryProgramSpec

3、MVC 层   

1、Action 控制层

      Action 类名：功能模块名称 +Action ；

      Actoin 方法名称尽可能的描述出页面迁移的去向

     如： LoginAction( 登录用 action) ， toWelcome( 转向欢迎页的 action 方法 )

2、资源文件

      系统全局资源文件： globalMessages_+ 字符编码类型 +.properties

      功能模块内部的资源文件： package.properties

4、Spring 配置文件

1、Action 相关配置文件

   文件目录：WebRoot/WEB-INF/spring/action/功能模块名称 +_ApplicationContext.xml

2、Services 相关配置文件

  文件目录：WebRoot/WEB-INF/spring/services/Services_ApplicationContext.xml

3、全局性配置文件

  文件目录：WebRoot/WEB-INF/spring/工程名+_ApplicationContext.xml

5、JSP 文件

  采用完整的英文描述说明 JSP 所完成的功能，尽可能包括一个生动的动词，第一个字母小写， 如： viewMessage.jsp 、editUser.jsp 等。

【下载地址】

链接：https://pan.baidu.com/s/12eOY_TMXHrB_W3yIAKxiuA

提取码：uies