您现在的位置是:首页 > 文章详情

IDEA 自定义方法注解模板

日期:2019-09-19点击:247

IDEA 自定义方法注解模板

1、使用效果

/** * 计算交易费用 * @Author wangjiafang * @Date 2019/9/11 * @param feeComputeVo * @return */ @PostMapping("/v1/fee_compute") public ApiResponse feeCompute(@RequestBody @Valid FeeComputeVo feeComputeVo){ return new ApiResponse(); } 

2、设置步骤-添加自定义方法

  1. File->settings->Editor->Live Templates

  2. 击右上角的绿色+号,然后选择template group ,然后输入group的name,随便输入就好了:wangjiafang。然后点ok

  3. 选中刚才创建的wangjiafang,然后再次点击右侧的绿色+,这次选择的是第一个 Live Template

  4. 取名为*

Live Template 定义的模板名是 * , 按/**, 然后space键盘, 方法注释就生产了,非常完美!; 网上普遍的方式是将模板名定义为: mc, 使用方式也相应不同, 其实使用方式倒无所谓, 但是mc这种方式有个要求, 必须再方法内使用才行,要不产生的注释param 是null..., 所以你用这种方式,要么你忍受方法内写注释,要么你手动把方法内生成的注释移到外面

  1. 把Expand with中 默认enter 修改为space,当然你也可以修改为其他的快捷方式;为什么要什么默认的enter,因为 /** 是idea的默认注释快捷,和要使用默认注释模板的地方冲突

  2. 注释模板代码

* * $desc$ * @Author wangjiafang * @Date $date$ $params$ * @return */ 

3、设置步骤-添加方法中的变量

IDEA 中methodParameters(), 是数组的形式([aParam, bParam, cParam]这样的结构),需要对methodParameters() 函数进行处理,处理脚本如下:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters()) 
原文链接:https://my.oschina.net/u/3339803/blog/3107905
关注公众号

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。

持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。

文章评论

共有0条评论来说两句吧...

文章二维码

扫描即可查看该文章

点击排行

推荐阅读

最新文章