IntelliJ IDEA 自动生成注释模板(优化)

9,625 阅读1分钟

1.jindent 插件

2.自定义注释模板

插件请自行了解,在此不作讨论。

本套模板优点

​ 可以在方法外获取参数(基于grovy脚本)

​ 支持提示信息 ​ 定点编辑:输入完成回车自动跳下一个待编辑内容的位置【通过skip if defined设置】

类注释模板

​ 新建类,会提示输入类的描述信息

第三部分代码

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*@program: ${PROJECT_NAME}
*@description: ${description}
*@author: Clover
*@created: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
*/
public class ${NAME} {
}

效果图

方法注释模板

1.创建模板组

2.创建模板项

3.修改组合键

4.填入模板并编辑变量

5.修改作用返回

6.apply  —> ok

编辑变量

模板

*
 * @Description: $description$
 * $params$
 * @return: $return$
 *
 * @Creator: $creator$
 * @Date: $CreateDate$ $CreateTime$
 *
 * @Modify: $modify$
 * @Date: $ModifyDate$ $ModifyTime$
 *
 */

描述信息生成脚本

groovyScript("def result='请在此处输入方法描述信息';return result")

参数获取脚本

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

效果图