接口太多,手写注释烦到死,网上找了下idea自定义注释设置,记录下实践过程。
1、此次idea的版本是
2、进入File->settings->Editor->Live Templates,新建一个Live Templates
3、在UserDefine新建一个Live Templates,其中template text的内容为
*
*
* $VAR1$
* @return $returns$
* @author yuan
* @date $date$ $time$
*/
第一行就是少了“/”,你没有看错,因为配置完成后是使用“/*”+tab键出发自动注释的,所以,加上前面的“/*”就刚刚好。变量使用$$装起来。
4、配置variable,idea的methodParameters()方法会返回一个参数数组,这样在代码中ctrl+Q无法获取到参数的信息,所以要将参数展开,其中VAR1是个groovy脚本,用于将参数展开换行显示,脚本如下:
groovyScript(" def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i!=0)result+= ' * '; result+='@param ' + params[i] + ((i < (params.size() - 1)) ? '\\n' + '\\t' : ''); }; return result", methodParameters())
5、配置完成点击应用,效果图如下
6、idea的检查机制,让注释看起来有点问题,将高亮设置从inspections降到syntax即可
参考:https://blog.csdn.net/yuruixin_china/article/details/80933835