0


IDEA-- 复制代码自动导包、新建类自动生成作者模板

需求: 复制代码进IDEA时不再需要手动导入包,而是复制进去工具自动导入

首先进入设置选项

之后勾选以下两项:

在这里插入图片描述
第一项:IntelliJ IDEA 将在我们书写代码的时候自动帮我们优化导入的包,比如自动去掉一些没有用到的包。

第二项: IntelliJ IDEA 将在我们书写代码的时候自动帮我们导入需要用到的包。但是对于那些同名的包,还是需要手动 Alt + Enter 进行导入的

新建类、方法自动生成作者、参数模板

新建类自动生成作者模板

Settings,点击 Editor–>File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加:

/**
 * @author JU
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

今后每次生成类,就会自动带有作者模板
在这里插入图片描述

方法注释

本文将实现以下功能:

  • 根据形参数目自动生成 @param 注解
  • 根据方法是否有返回值智能生成 @Return 注解

相较于类模板,为方法添加注释模板就较为复杂,

  1. 首先在 Settings 中点击 Editor–>Live Templates。

  2. 点击最右边的 +,首先选择 2. Template Group… 来创建一个模板分组:在这里插入图片描述

  3. 在弹出的对话框中填写分组名,我这里叫做 userDefine: 然后选中刚刚创建的模板分组 userDefine,然后点击 +,选择 1. Live Template:在这里插入图片描述

  4. 此时就会创建了一个空的模板,我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是,Abbreviation 必须为 * ,最后检查下 Expand with 的值是否为 Enter 键。在这里插入图片描述

  5. 点击 Define,在弹框中勾选 Java,表示将该模板应用于所有的 Java 类型文件。

在这里插入图片描述

  1. 还记得我们配置 Template text 时里面包含了类似于 d a t e date date 这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮,为每一个参数设置相对应的 Expression::在这里插入图片描述
  2. 需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 和 return IDEA 默认的实现很差,因此我们需要手动实现,代码如下:

在这里插入图片描述

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

注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。

点击 OK 保存设置,大功告成!

Q & A

(1)为什么模板的 Abbreviation 一定要叫 * ?Expand with 要保证是 Enter 键?

答:因为 IDEA 模板的生成逻辑是 模板名 + 生成键,当生成键是 Enter 时,我们输入 * + Enter 就能够触发模板。

这也同时说明了为什么注释模板首行是一个 * 了,因为当我们先输入 /*,然后输入 * + Enter,触发模板,首行正好拼成了 /**,符合 Javadoc 的规范。

(2)注释模板中为什么有一行空的 * ?

答:因为我习惯在这一行写方法说明,所以就预留了一行空的写,你也可以把它删掉。

(3)注释模板中

     t 
    
   
     i 
    
   
     m 
    
   
     e 
    
   
  
    time 
   
  
time 
 
  
   
   
     p 
    
   
     a 
    
   
     r 
    
   
     a 
    
   
     m 
    
   
  
    param 
   
  
param 这两个明明不相干的东西为什么紧贴在一起?

答:首先网上提供的大部分 param 生成函数在无参情况下仍然会生成一行空的 @param,因此我对param 函数的代码进行修改,使得在无参情况下不生成 @param,但是这就要求

     p 
    
   
     a 
    
   
     r 
    
   
     a 
    
   
     m 
    
   
  
    param 
   
  
param 要和别人处在同一行中,不然没法处理退格。

(4)为什么 return 参数不使用 methodReturnType(), 而要自己实现?

答:methodReturnType() 在无返回值的情况下会返回 void,这并没有什么意义,因此我对 methodReturnType() 返回值进行了处理,仅在有返回值时才生成。

(5)为什么

     r 
    
   
     e 
    
   
     t 
    
   
     u 
    
   
     r 
    
   
     n 
    
   
  
    return 
   
  
return 不是单独一行?

答:因为当 methodReturnType() 返回 null 时,无法处理退格问题,原因同第三点。

标签: intellij-idea java ide

本文转载自: https://blog.csdn.net/m0_46671240/article/details/135988371
版权归原作者 SunsPlanter 所有, 如有侵权,请联系我们删除。

“IDEA-- 复制代码自动导包、新建类自动生成作者模板”的评论:

还没有评论