使用IDEA生成JavaDoc文档+自定义注解模板

一、注释标签介绍

标记	说明	标签类型
@author	作者标识	包、类、接口
@version	版本号	包、类、接口
@param	方法的入参名及描述信息，如入参有特别要求，可在此注释	构造函数、方法
@return	对函数返回值的注释	方法
@deprecated	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在．以此告之开发者不应再用这个API	包、类、接口、值域、构造函数、方法
@throws	构造函数或方法所会抛出的异常	构造函数、方法
@exception	同@throws	构造函数、方法
@see	查看相关内容，如类，方法，变量等	包、类、接口、值域、构造函数、方法
@since	API在什么程序的什么版本后开发支持	包、类、接口、值域、构造函数、方法
@link	链接到某个特定的成员对应的文档中	包、类、接口、值域、构造函数、方法
@value	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值	静态值域

此外还有@serial、@serialField、@serialData、{@docRoot)、{@inheritDoc)、{@lteral})、{@code} {@value arg}几个不常用的

二、IDEA生成JavaDoc文档

2.1、IDEA选择Tools->Generate JavaDoc

2.2、注意以下三个地方

1. 第一个是设置输入的地址

最好先弄一个空文件夹，再把地址定到那里，这个JavaDoc文件是一堆文件的，得放一个空文件夹好查看

2. 第二个是设置语言

zh_CN

3. 第三个是设置字符集编码

-encoding utf-8 -charset utf-8

2.3、注意

以上注释标签里在模板里一定要写规范，否则生成JavaDoc文档时会报错，比如把@author写成@Author

三、自定义注解模板

3.1、注解在类上

3.1.1图内模板

/** 
 * 
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

3.2、注解在方法上

3.2.1、params里的脚本代码

groovyScript(“def result=’’; def params=”${_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) {if(params[i] == ‘’) continue;if(i==0) result += params[0]+((params.size()==1)?’’:’\n’);else{ result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}}; return result", methodParameters())

3.2.2、图内模板

*
 *
 * @param $params$
 * @return $return$
 * @author DengHongWei
 * @date $date$ $time$
 */