在IDEA中设置java文档注释教程

1.添加类的文档注释

首先打开IEDA后，依次选择设置(Settings)  ->编辑器（Editor） ->文件和代码模板（File and Code Templates） ->Includes

在右上角的方框中输入以下内容

/**
 *@author ${USER}
 *@Date  ${DATE} ${TIME}
 *@package ${PACKAGE_NAME}
 *@Description:
 
 */

点击apply,此后再创建类时，将自动为类生成一些文档注释，效果如下图

2.添加方法的文档注释

打开IEDA后，依次选择设置(Settings)  ->编辑器（Editor） ->实时模板（Live Templates）

点击左上角的“+”，选择创建模板组，再向组中添加一个自定义模板

将下面的内容填入模板文本

*
 * @discription
 * @author $user$
 * @date $date$ $time$ $param$ 
 * @return {@code $return$}    
 **/

然后设置自定义模板的缩写、展开方式，填写描述

点击左下角设置模板的应用范围，然后再点击编辑变量

按照下图所示，填入变量的表达式

其中，param的完整表达式为

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

return的完整表达式为

groovyScript("return \"${_1}\" == 'void' ? null : '' + \"${_1}\"", methodReturnType())

填写完毕后点击apply，然后在我们想要生成文档注释的方法中输入/** 按下回车，将自动生成该方法的文档注释，效果如下图