IDEA Java 类注释、方法注释模板(可实现自动参数使用生成)
JAVA 类文件注释设置
设置地方:
模板
- 1 /**
- 2 * <p>
- 3 * $description
- 4 * </p>
- 5 *
- 6 * @author Tophua
- 7 * @since ${DATE}
- 8 */
方法注释:
配合模板和参数可实现0参和多参的方法模板
新增,然后编辑写入模板和脚本。
先增模板组,再增模板(先2后1)
模板:
- **
- * <p>
- *
- * </p>
- * $param$ $return$
- * @author Tophua
- * @since $date$
- */
点击右边按钮添加脚本
按钮点击详情
参数(param)脚本
- 1 groovyScript("def result=\'\\n\'; def params=\"${_1}\".replaceAll(\'[\\\\[|\\\\]|\\\\s]\', \'\').split(\',\').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == \'\') return \' \'; result+=\' * @param \' + params[i] + \' \' + params[i] + ((i < params.size() - 1) ? \' \\n\' : \' \')}; return result", methodParameters())
参数(return)脚本,两个都可以,根据需求选择
使用脚本可过滤void返回生成->只有有实际返回类型才回生成@return
脚本1 :返回全量方法返回类型(包括包名和泛型)
- 1 groovyScript("def param=\"${_1}\"; if(param == \'\' || param == \'void\') return \'\'; return \' \\n * @return \' + param", methodReturnType())
脚本2:返回简洁方法返回类型(无包名无泛型,只有简单的主要类型)
- 1 groovyScript("def param=\"${_1}\"; if(param == \'\' || param == \'void\') return \'\'; param = param.replaceAll(\'<.*>\', \'\'); param = param.substring(param.lastIndexOf(\'.\') + 1); return \'\\n * @return \' + param", methodReturnType())
添加使用范围
鼠标右键选择如图位置或点击下面快捷地方
勾选java
完成配置
使用:在方法上键入 /* + tab键即可生成。