IDEA 注释模板设置
Posted youngyajun
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了IDEA 注释模板设置相关的知识，希望对你有一定的参考价值。
1.类注释模板设置
IDEA --> Settings... --> Editor --> File and Code Templates --> Includes -->File Header
/** * ClassName: $NAME * Package: $PACKAGE_NAME * Description: * Datetime: $DATE $TIME * Author: XXXXX@XX.com */
2.方法注释模板设置
IDEA --> Settings... --> Editor --> Live Templates --> 点击+号 -->Template Group...(添加模板组)
添加了模板组后再次点击+号，这次选择Live Template(添加注释模板)
2.1 Abbreviation: 该处填入* （注意设置的模板名称为*，此处一定要填写*,因为IDEA生成注释的默认方式是：/*+模板名+快捷键）
2.2 Description：该处填入调用模板时的提示
2.3 Tempate test内容：
**
* @Description
$params$
$return$
* @Author $author$
* @Datetime $date$ $time$
*/
一定要以**开头
2.4 Edit variables：
params Default value内容：
groovyScript("if(\\"$_1\\".length() == 2) return ‘‘; else def result=‘‘; def params=\\"$_1\\".replaceAll(‘[\\\\\\\\[|\\\\\\\\]|\\\\\\\\s]‘, ‘‘).split(‘,‘).toList();for(i = 0; i < params.size(); i++) if(i==0)result+=‘* @param ‘ + params[i] + ‘: ‘elseresult+=‘\\\\n‘ + ‘ * @param ‘ + params[i] + ‘: ‘; return result;", methodParameters());
return Default value内容：
groovyScript("def returnType = \\"$_1\\"; def result = ‘* @return ‘ + returnType; return result;", methodReturnType());
author、date、time处变量分别点击，下拉后选择user(),date(),time()
2.5 Expand with处选择Tab键补全，默认也是按Tab键补全（设置为Enter键，类属性文档注释会有冲突）
2.6 Change处选择Java
流程预览：
测试效果：
方法上输入/*后按Tab键自动补全
以上是关于IDEA 注释模板设置的主要内容，如果未能解决你的问题，请参考以下文章