欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

idea自动生成方法注释(含参数及返回值)

程序员文章站 2024-03-12 13:13:20
...

之前有配置过一个方法注释,不过方法的参数和返回值不能自动生成,昨天偶遇一篇文章,有提到了一种配置方式,今天试了下,经过一番调试,大功告成。效果如图:

idea自动生成方法注释(含参数及返回值)

idea自动生成方法注释(含参数及返回值)
File->settings->Editor->Live Templates
idea自动生成方法注释(含参数及返回值)

点击+->选择template group ,然后输入group的name,如annotation。
然后,选中刚才创建的myGroup,然后再次点击右侧的绿色+,这次选择的是第一个1. Live Template。取名为*。

配置模板

*
 * 
 * $VAR1$ 
 $params$ * @return $returns$
 * @author yuxin
 * @creed: Talk is cheap,show me the code
 * @date $date$ $time$
 */

配置variables,点击 Edit variables
idea自动生成方法注释(含参数及返回值)

其中VAR1对应的脚本如下:

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())

注意要勾选所需文件格式
idea自动生成方法注释(含参数及返回值)

开始使用
输入/**,然后回车,大功告成


    /**
     *
     * @param id
     * @param userId
     * @param returnOpenidUri
     * @return com.medical.enrol.vo.MedicalEnrollmenRtegulationsCardInfoVO
     * @author yuxin
     * @creed: Talk is cheap,show me the code
     * @date 2018/7/5 0005 下午 10:04
     */

参考链接:
https://zhuanlan.zhihu.com/p/32891910
https://blog.csdn.net/u014044812/article/details/76577479