在Eclipse中设置自动生成javadoc注释

转自：http://jingyan.baidu.com/article/a501d80c09dab1ec620f5e4b.html

http://www.cnblogs.com/fsjohnhuang/p/3988883.html

windows-->preference-->Java-->Code Style-->Code Templates-->code-->new Java file

例如在new java file中编辑模版如下：

${filecomment}${package_declaration}
/** 
* @author : suyuyuan
* @date 创建时间：${date} ${time} 
* @version 1.0 
* @parameter  
* @since  
* @return  
*/
${typecomment}${type_declaration}

新建class类时就会出现如下效果：

package com.suyuyuan.demo.common;
/** 
* @author : suyuyuan
* @date 创建时间：2016年3月15日 下午5:40:45 
* @version 1.0 
* @parameter  
* @since  
* @return  
*/
public class Test {


}

再如：

${filecomment}
${package_declaration}
/**  
* 
* @ClassName: ${type_name}
* @Description: ${todo}
* @author suyuyuan
* @date ${date} ${time}
*
*/
${typecomment}
${type_declaration}

样式如下：

package Util;
/**  
* 
* @ClassName: Test
* @Description: TODO
* @author suyuyuan
* @date 2016年10月10日 上午10:08:45
*
*/
public class Test{


}

-------------------分割线------------------------

以下是如何给java类中的方法自动添加注释：

windows-->preference-->Java-->Code Style-->Code Templates-->Comments-->Methods-->Edit

编辑输入：

/**

 * 
 *
 *  ${tags} ${return_type}
 */

保存即可。

在使用时，双击想要添加注释的方法，按下组合快捷键：Alt+Shift+J，即可。

---------------分割线--------------------

一、注释　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

  1. 注释类型

     [a]. 单行注释

// 单行注释
String type = "单行注释";

     [b]. 多行注释

/* 
 * 多行注释
 */
String type = "多行注释";

     [c]. 文档注释

/**
 * 文档注释
 */
public class Dummy{}

  2. 快捷键

     [a]. 添加/取消单行注释： Ctrl+/ 

     [b]. 添加类的文档注释： Ctrl+Shift+j 

 

二、注释模板　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 

  作用：定义文件、类和方法等默认的注释格式，减少手工输入的工作量。

  1. 设置注释模板的入口：点击 Window->Preference->Java->Code Style->Code Template ，然后展开 Comments节点 。

  2. Comments节点 下的元素介绍：

     File节点（文件注释标签）

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author fsjohnhuang
* @date ${date} ${time} 
* @version V1.0   
*/

     Types节点（类注释标签）

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author fsjohnhuang
* @date ${date} ${time} 
* 
* ${tags} 
*/

      Fields节点（字段注释标签）

/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 

     Constructor节点（构造函数注释标签）

/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

     Method节点（方法注释标签）

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param ${tags}  参数说明 
* @return ${return_type}    返回类型 
* @throws 
*/

     Overriding Methods节点（覆盖方法注释标签）

/*
* Title: ${enclosing_method}
*Description: 
* ${tags} 
* ${see_to_overridden} 
*/

    Delegate Methods节点（代理方法注释标签）

/** 
* ${tags} 
* ${see_to_target} 
*/ 

    getter节点（getter方法注释标签）

/** 
* @return ${bare_field_name} 
*/

    setter节点（setter方法注释标签）

/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/

  3. 导入、导出注释模板

    在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。