我们经常写代码的时候需要在类上编写注释,标明这个类是谁写的有什么作用,其实每次写都会发现有很多相同的字段,比如作者,创建时间,类名等,有的时候方法上也要标明方法的返回值,参数等信息,在idea里边我们可以给设置自动加载注释。
1、创建类的时候自动加上注释
首先在idea里边选择file——setting根据如图所示进行操作
在includes里边的添加注释配置
/**
* @Author qintianxian
* @Date ${DATE} ${TIME}
* @PackageName:${PACKAGE_NAME}
* @ClassName: ${NAME}
* @Description: TODO
* @Version 1.0
*/
点击apply,这里就配置成功了,点击ok就退出配置页面了,所以我就先apply一下,配置完方法注解再去进行测试,如果你退出去了也没事,原路找回来就行
2、在方法上添加注解(File–>Settings–>Editor–>Live Templates)
点击右上角的加号新建Template Group
自己可以随意命名一个名字
然后选中新建的这个组,然后点击右上角+号,选择Live Template
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,且
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为: /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()
当然这并不是所有人都是这样的,你可以选择你自己需要的参数留着
同样的方式再创建一个方法注解
*
* @author: qintianxian
* @date: $date$ $time$
* @Description: TODO
$param$
* @return: $return$
*/
方法参数的获取用groovy脚本获取展示好一点,当然用下拉选择methodParameters()也行,只不过展示时就是一个数组型-即把参数[ ]装起来,个人觉得每个参数占一行比较好看,所以这里用groovy脚本获取:
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())
选择ok,这样我们配置就结束了,就可以去进行测试操作了。
设置成功后点击OK,首先我们先创建一个测试类,发现自动生成了,然后新建一个方法,写完入参和返回值以后,在方法上面:
敲出:/** 回车
至此配置成功