eclipse中javadoc注释的设置

    代码中写规范的注释是有必要的，eclipse中可设置code templates中的comments， 定义好注释的模板，方法或类上敲 /** + 回车，能方便的生成自定义的javadoc注释块，减少一些重复的工作。

    comments中定义了9种类型的注释，平时也很少注意规范的注释，以后注意，慢慢完善，这里先大概记录一下：

    1、Files 文件头标记，可定义修改历史、版权信息等

/**
 *@(#) ${file_name}
 * Modify Information:
 *   Author      Date       Description
 *   --------- ---------- --------------
 *   ${user}     ${date}      1.0.0

 *   Copyright ${year} ${user} All rights reserved 
 */

     2、Types 文件头标记，类或接口的一些基本信息

/**
 * <br>create date：${date}
 * @author ${user}
 * @since 1.0
 * @version 1.0
 * @see
 */

      3、Fields 变量， 类中暴露的public常量/变量可添加javadoc注释

/**
 * @see
 */

       4、Constructors  构造函数， 特殊的methods

/**
 * ${tags}
 */

      5、Methods  方法, 包括方法描述，入参，返回值，异常等信息。有需要也可以定义 @deprecated， @see

/**
 * @since
 * ${tags}
 * <br>author： ${user}
 * <br>create time：${date} ${time}
 */

    6、getter/setter  方法,  eclipse自动生成时，会带上注释

getter:
/**
 * @return the ${bare_field_name}
 */

setter:
/**
 * @param ${param} the ${bare_field_name} to set
 */