IDEA修改方法注释

  • Post author:
  • Post category:其他




一、重要性

在团队合作中,每个方法或者类都需要一个合理的注释,这样在合作中当遇到问题的时候,可以听过注释理解目标代码或者是通过注释找到代码的对应负责人



二、IDEA修改模板



1. 配置窗口路径


file->Setting->Editor->Live Templates


在这里插入图片描述



2. 配置快捷方式

(1) 新建一个组

在这里插入图片描述

在这里插入图片描述

(2)定义一个模板

在这里插入图片描述

在这里插入图片描述



3. 设置模板

 * 
 *@Author $user$
 * @Description //TODO $end$
 * @Date  $date$ $time$
$param$
 * @return $return$
 */

在这里插入图片描述



4. 参数配置

(1)基本参数配置

在这里插入图片描述

在这里插入图片描述

(2)参数拓展

在这里插入图片描述


拷贝到Expression



groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())

在这里插入图片描述



5. 补充

如果出现模板

*

号个数有问题,或者是方法注释没有对齐这种问题

可以通过修改自定义的模板赖解决问题

在这里插入图片描述



版权声明:本文为lijiabin417原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。