java代码注释规范

java代码注释规范

1、规范存在的意义

    应用编码规范对于软件自己和软件开发人员而言尤其重要，有如下几个缘由：

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

    二、好的编码规范能够改善软件的可读性，可让开发人员尽快而完全地理解新的代码；

    三、好的编码规范能够最大限度的提升团队开发的合做效率；

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

2、命名规范

     一、通常概念

        一、尽可能使用完整的英文描述符

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

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

        四、尽可能少用缩写，但若是用了，必须符合整个工程中的统必定义
       
        五、避免使用长的名字（小于 15 个字母为正常选择）

        六、避免使用相似的名字，或者仅仅是大小写不一样的名字

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

      二、标识符类型说明

        一、包（ Package ）的命名
            Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。而且包名的前缀老是一个顶级域名，
            一般是 com、edu、gov、mil、net、org 等；
            如： com.yjhmily.test

        二、类（ Class ）的命名
            类名应该是个一名词，采用大小写混合的方式，每一个单词的首字母大写。尽可能保证类名简洁而富于描述。
            使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更普遍使用，像 URL ， HTML)
        如： FileDescription

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

        四、枚举（ Enum ）的命名
            基本与 Class 的命名规范相似。在知足 Classd 命名规则的基础之上，保证开头第一个字母为 ”E” ，
            便于与普通的 Class区别开。
        如： EUserRole

        五、异常（ Exception ）的命名
            异常（ Exception ） 一般采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception
        如： BusinessException

        六、方法（ Method ）的命名
            方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
            方法名尽量的描述出该方法的动做行为。返回类型为 Boolean 值的方法通常由“ is ”或“ has ”来开头
        如： getCurrentUser() 、 addUser() 、 hasAuthority()

        七、参数（ Param ）的命名
            第一个单词的首字母小写，其后单词的首字母大写。参数量名不容许如下划线或美圆符号开头，
            虽然这在语法上是容许的。参数名应简短且富于描述。
        如： public UserContext getLoginUser(String loginName);
       
        八、常量字段 （ Constants ）的命名
            静态常量字段（ static final ） 所有采用大写字母，单词之间用下划线分隔；
        如： public static final Long FEEDBACK;
        public static Long USER_STATUS;

  3、注释规范

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

            问问你本身，你若是从未见过这段代码，要在合理的时间内有效地明白这段代码，你须要一些什么信息？？？

         一、通常概念

            一、注释应该增长代码的清晰度

            二、保持注释的简洁

            三、在写代码以前或同时写注释

            四、注释出为何作了一些事，而不只仅是作了什么

         二、注释哪些部分

            一、Java 文件：必须写明版权信息以及该文件的建立时间和做者；

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

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

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

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

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

            七、属性： 字段描述；

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

         三、注释格式

            遵循工程规定的统一注释格式，通常状况下会以 codetemplates.xml 格式的文件导入 IDE(Eclipse)
            或者用Eclipse默认的；

4、代码格式规范

        遵循工程规定的统一代码格式，通常状况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化；

一、单行(single-line)--短注释：//……   
单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具备同样的缩进层级。若是单行没法完成，则应采用块注释。
注释格式：
行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式：// 注释内容
行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。通常与代码行后空8（至少4）个格，全部注释必须对齐。
注释格式：代码 + 8（至少4）个空格 + // 注释内容
二、块(block)--块注释：
注释若干行，一般用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。通常位于一个文件或者一个方法的前面，起到引导的做用，也能够根据须要放在合适的位置。这种域注释不会出如今HTML报告中。注释格式一般写成：

三、文档注释：
注释若干行，并写入javadoc文档。每一个文档注释都会被置于注释定界符
之中，注释文档将用来生成HTML格式的代码报告，因此注释文
档必须书写在类、域、构造函数、方法，以及字段(field)定义以前。注释文档由两部分组成——描述、块标记。注释文档的格式以下：

public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
    doPost(request, response);
}
前两行为描述，描述完毕后，由@符号起头为块标记注释。更多有关文档注
释和javadoc的详细资料，参见javadoc的主页：  http://java.sun.com/javadoc/index.html
四、javadoc注释标签语法
@author    对类的说明 标明开发该类模块的做者
@version   对类的说明 标明该类模块的版本
@see      对类、属性、方法的说明 参考转向，也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return    对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明
6、JAVA注释具体实现
一、源文件注释
源文件注释采用 ，在每一个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；做者；建立时间；文件描述包括本文件历史修改记录等。中文注释模版：

二、类（模块）注释：
类（模块）注释采用 ，在每一个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类能够运行的JDK版本；版本号；做者；建立时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。
英文注释模版：

若是模块只进行部分少许代码的修改时，则每次修改须添加如下注释：
//Rewriter
//Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：

//End1：
将原代码内容注释掉，而后添加新代码使用如下注释：
//Added by
//Add date：<添加日期，格式：YYYY-MM-DD> Start2：
//End2：
若是模块输入输出参数或功能结构有较大修改，则每次修改必须添加如下
注释：
//Log ID：
//Depiction：<对此修改的描述>
//Writer：修改者中文名
//Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>
二、接口注释：
接口注释采用 ，在知足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明做者和版本。在接口注释清楚的前提下对应的实现类能够不加注释。
三、构造函数注释：
构造函数注释采用 ，描述部分注明构造函数的做用，不必定有块标记部分。
注释模版一：

注释模版二：

四、函数注释：
函数注释采用 ，在每一个函数或者过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。函数注释里面能够不出现版本号（@version）。
注释模版一：

注释模版二：

五、方法注释：
方法注释采用 ，对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的状况下，能够不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的建立时间必须注释清楚，为未来的维护和阅读提供宝贵线索。
六、方法内部注释：
控制结构，代码作了些什么以及为何这样作，处理顺序等，特别是复杂的逻辑处理部分，要尽量的给出详细的注释。
七、 全局变量注释：
要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
八、局部（中间）变量注释：
主要变量必须有注释，无特别意义的状况下能够不加注释。
九、实参/参数注释：
参数含义、及其它任何约束或前提条件。
十、字段/属性注释： 字段描述，属性说明。
十一、常量：常量一般具备必定的实际意义，要定义相应说明。

 －－－－－－－－－－－－－华丽的分割线－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

myeclipse的注释相关

1.对java文件的自动注释

Window->Preference－＞Java -> Code Style -> Code Templates

files:新建文件时的注释

Types：类的注视

Field：变量的注释

Constructors:构造函数的注释

methods：通常方法的注释

能够在里edit一些固定的格式或变量 其中user默认取操做系统的名称，能够写死。 日期格式俺想知道怎么改为yyyy-mm-dd

2.对JSP文件的注释

Window->Preference-myeclipse-editors-JSP-JSP TEMPLATES

 3.在java中用的一些快捷 例：sysout

Window->Preference-java-editor-templates

能够本身写一些参数~例如 user ---zhongjb

5、其余规范

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

6、工程特有命名规范

          一、持久层

            一、 Hibernate 映射文件及实体
                与数据库表名称彻底对应；
                如： Advertisement.hbm.xml 、 Advertisement.java

            二、数据访问 DAO
                DAO 接口和实现类名称必须彻底符合正常接口和实现类的命名规则，且最后以 ”DAO” 结尾
                DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操做；
                如： ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )
           
            三、各类操做数据库的 HQL 配置文件
                HQL 文件的个数原则上与系统的 Services 层的服务个数相等，且以服务名称命名 HQL 文件；
                如： resource.hbm.xml

        二、服务层

            一、服务接口和实现
                服务接口和实现类必须彻底符合正常接口和实现类的命名规则；以工程定义的服务名为主体，
                并统一以 ”Serv” 结尾
                如： IResourceServ( 服务接口 ) 、 ResourceServ( 接口实现类 )

            二、服务接口方法
                方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
           方法名尽量的描述出该方法的动做行为。
                返回类型为 Boolean 值：用“ is ”或“ has ”来开头
                获得某数据： get+ 数据描述名词复数 + 数据类型；
                获得全部数据： get+All+ 数据描述名词复数 + 数据类型；
                经过 XXX 获得 / 查询某数据： get/query+ 数据描述名词复数 + 数据类型 +By+ 条件；
                添加某数据： save/add+ 数据描述名词 ()
                更新某数据： save/update+ 数据描述名词；
                删除某数据： delete/remove+ 数据描述名词；

            三、业务对象
                业务名称 +BO

            四、查询参数对象
                凡是继承 Abst***QuerySpec 的查询参数类所有知足如下规则：
                Query+ 所要查询的数据描述名词 +Spec
                做为参数传入时，参数名必须为：所要查询的数据描述名词 +Spec
                如： QueryProgramSpec

        三、MVC 层           

            一、Action 控制层
                Action 类名：功能模块名称 +Action ；
                Actoin 方法名称尽量的描述出页面迁移的去向
                如： LoginAction( 登陆用 action) ， toWelcome( 转向欢迎页的 action 方法 )

            二、资源文件
                系统全局资源文件： globalMessages_+ 字符编码类型 +.properties
                功能模块内部的资源文件： package.properties

         四、Spring 配置文件

            一、Action 相关配置文件
                文件目录： WebRoot/WEB-INF/spring/action/ 功能模块名称 +_ApplicationContext.xml

            二、Services 相关配置文件
                文件目录： WebRoot/WEB-INF/spring/services/Services_ApplicationContext.xml

            三、全局性配置文件
                文件目录： WebRoot/WEB-INF/spring/工程名+_ApplicationContext.xml

        五、JSP 文件            采用完整的英文描述说明 JSP 所