目录
1、使用场景
我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什么主要作用等描述信息;以及创建方法的时候能够支持自定义的模板(方法的描述信息、创建方法的开发人员、创建日期和时间、参数名称、返回类型等)
2、操作步骤
2.1、新建类模板注释添加
操作菜单顺序:File-->Settings-->Editor-->File and Code Templates-->Includes
修改File Header里面的模板内容如下模板代码:
/**
* @Description TODO
* @Classname ${NAME}
* @Date ${DATE} ${TIME}
* @Created by ${USER}
*/
在完成上面操作后如下图所示:
2.2、给类的方法生成方法注释
网络上关于给类方法生成注释一大堆文章;但是90%的文章都是copy的没有实操。估计很多人都遇见过params和return参数无法返回,或者返回效果不佳的情况。
操作步骤:File-->Settings-->Editor--> Live Templates
新建自己的分组和自己的模板,这都不说了,界面如图
其中第1步选择创建自定义组,第2步选择创建模板
点击右边的”+“号,选择Template Group
第2步创建Live template
内容源码及说明:
Abbreviation那里不要用 / 开头的!!! 模板中开头不要 / ,从* 号开始 模板如下:
**
* description:
* @since: 1.0.0
* @author: 作者拼音或者英文名称
* @date: $date$ $time$
$params$
$returns$
*/
其中第一行必须为**(两个星号) 其中参数 $params$ $returns$ 前面无需@符号
点击 Define 选择java,也可以选择everywhere
设置变量内容:
重点注意事项(以下框里面内容设置或者选定):
其中params和return都是设置 Default value groovyScript脚本(网上大部分不能使用)
params groovyScript脚本
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] + ': '}else{result+='\\n' + ' * @Param ' + params[i] + ': '}}; return result;}", methodParameters());
return groovyScript脚本
groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());
设置 点击 应用,确定
重点:注释时需要自己打 / 符号(m),然后再打*,然后tab,这样就可以获取了!!!
3、成果展现
4、参考文章
找到的唯一两篇靠谱的文章
IDEA自定义注释模板(主要解决params和return的问题)
IDEA 配置方法注释@param时自动参数的问题,亲自实践总结有效。
其中操作详情可以参考此文章IDEA创建类模板和方法模板(超详细)