idea注释模板

超、凢脫俗 2024-03-26 13:31 84阅读 0赞

#### 文章目录 ####

*  操作步骤
 *   *  1.新建模板组
     *  2.新建模板
     *  3.配置类注释模板
     *  4.配置方法注释模板

--------------------

## 操作步骤 ##

### 1.新建模板组 ###

快捷键Ctrl + Alt + s 打开 idea设置 , 位置所在: Editor > Live Templates ;  
点击 + 号  
选择 2.Template Group ,新建模板组  
![在这里插入图片描述][0051f815e01547049b21a574be2964a1.png]

### 2.新建模板 ###

点击 + 号 , 选择 1.Live Template  
Abbreviation 是修改模板名称  
点击下方的Define, 勾选Java选项

![在这里插入图片描述][158033ac6b0849daadb3fc8dcc06ea78.png]

### 3.配置类注释模板 ###

> `类注释如何使用? 输入 /c 回车即可`

**
     * Description: [] 
     * @version: 1.0
     * @author: $user$
     * @date: $date$ $time$
     */

点击Edit variables 配置变量

![在这里插入图片描述][72d29424ef9148d7bbaa0e558dd16425.png]

> 效果如下

![在这里插入图片描述][78a308e82ffd4986a5a04f0ee3cc2f39.png]

### 4.配置方法注释模板 ###

> `方法注释如何使用? 输入 /m 回车即可`

**
     * Description: []  
     * @author: $user$
     $param$
     * @return: $returns$
     * @date: $date$ $time$
     */

点击Edit variables 配置变量

![在这里插入图片描述][822422bd460a4c93ae5588dec245b871.png]

**参数表达式**

1、只有参数名称,没有类型

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 == '' ? '* @param ' : result", methodParameters())

> 效果如下

![在这里插入图片描述][2794423daf3c41d7b22285a2f72cd2c6.png]

2 、参数名称,类型都有

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

> 效果如下

![在这里插入图片描述][ba368ce108ca4220b562d3d21a4d1065.png]

**返回类型表达式**

1、只有具体返回类型

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

> 效果如下

![在这里插入图片描述][e48b91f694fc4383b37ce55f04c9d515.png]

2、全路径返回类型

直接使用idea推荐的方法 methodReturnType()

> 效果如下

![在这里插入图片描述][a0eb13434b0349b9a5536694e9e97255.png]

--------------------

[0051f815e01547049b21a574be2964a1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/81da27a5b7454b2fbfeb4ad2a91b123d.png
[158033ac6b0849daadb3fc8dcc06ea78.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/58ed45366c804e928c74c0cc701a73a7.png
[72d29424ef9148d7bbaa0e558dd16425.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/f819b9db21dd4eb7bb6a8ba04a36d3cf.png
[78a308e82ffd4986a5a04f0ee3cc2f39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b50afb444ea14579a500ba31dafc0634.png
[822422bd460a4c93ae5588dec245b871.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/bff4f7259cb5469dacf9594e15cfa2c9.png
[2794423daf3c41d7b22285a2f72cd2c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/c8c0d44a7c23406e8958a41cea0e610a.png
[ba368ce108ca4220b562d3d21a4d1065.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/761050a5038f4c58b59ce08b635f3537.png
[e48b91f694fc4383b37ce55f04c9d515.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/965abc13171f4a38ae956d9bb44b8bf9.png
[a0eb13434b0349b9a5536694e9e97255.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/aed080da997f4ebd8eaac2e75a5cc6f3.png