IDEA给类和方法配置注释模板(参数换行显示)

创建类模板

1.打开设置：File–>settings–>Editor–>File and Code Templates–>Includes

2.输入注释模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 * @className ${NAME}
 * @description TODO
 * @author Sue
 * @create ${DATE} ${TIME}
 **/
#parse("File Header.java")
public class ${NAME} {
}

或

*
 * description: $description$
$params$
 * @return: $returns$
 * @author: Sue
 * @date: $date$ $time$
 */

3.结果

创建方法模板

1.按照顺序打开File–>Settings–>Editor–>Live Templates

2.点击右边的”+“号,选择Template Group

3.填写组名

4.选择组名，并在下面添加模板 Live Template

5.填写Abbreviation，Description，Template text ，这里的Define可以选择Java

　 注释模板:

*
 * @description: $description$
 * @param: $params$
 * @return: $returns$
 * @author: Sue
 * @date: $date$ $time$
 */

6.设置Edit variables，选择相应的表达式即可

 注意这里说明使用的是tab 的方式使用注释模板

7.使用，在方法上使用/*add + tab键即可自动生成注释

注意，这里如果想让每个参数单行显示，可以在设置变量时添加以下脚本：

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

注释模板

 * TODO: $description$
$params$
 * @return: $returns$
 * @author: Sue
 * @date: $date$ $time$
 */

这时生成的模板文件如下所示：