idea 自定义注解模板

柔光的暖阳◎ 2023-06-06 12:11 18阅读 0赞

# 前言 #

为了提代码编写速度，特写此文

# 正文 #

## 1.类注释模板 ##

打开设置 ：settings -> Editor ->File and Code Templates  
选择 file -》 class  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70]  
选择 include -》 file header  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 1]  
类注释模板保存完成！！！！

## 2.方法注释模板 ##

打开设置： File 》 Settings 》 Editor 》Live Templates  
新增个人模板组  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 2]  
新增个人的方法模板  
\*mth：方法名  
方框区域内编写模板内容![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 3]  
例：

*
     * @Description: $methoName$
     * @methoName: $methoName$
     * @param $param$
     * @return: $return$
     * @throws: $throws$
     * @date: $date$ $time$
     * @author: zhang san
     */

*   m e t h o N a m e methoName methoName 方法名
 *   p a r a m param param 参数
 *   r e t u r n return return 返回值
 *   t h r o w s throws throws 异常抛出
 *   d a t e date date  t i m e time time 时间
 *  @author: 作者  
    点击按钮配置参数：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 4]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 5]因参数可能会有多个直接写表达式

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+=params[i] + ': '}else{result+='\\n' + ' * @Param ' + params[i] + ': '}}; return result;}", methodParameters());

点击ok，保存  
选择使用范围  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 6]  
保存完成  
测试：  
在方法上输入/\*\*mth，点击回车键，成功  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70]: /images/20230601/742b8ee102294471a1b046313d780c2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 1]: /images/20230601/06b5aa1ca5914b8da50cf3c173f548ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 2]: /images/20230601/614df9c14c254c6f9b71f10fae84cd2b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 3]: /images/20230601/2864a7630d7845c89bb585d9ae211452.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 4]: /images/20230601/1dc671a580d143eaa8a452cb29d1aaa8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 5]: /images/20230601/6c0ce6a1adad443a970d98f88cdeb2af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 6]: /images/20230601/bafa36c29ba340c98241b482301d6179.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzMDQwNTUy_size_16_color_FFFFFF_t_70 7]: /images/20230601/e8444a0ea2904ae8991ef3fab6b8db59.png