IDEA注释模版（Java param括号、return全类名）

以你之姓@ 2022-11-20 09:36 428阅读 0赞

## IDEA注释模版（Java param括号、return全类名） ##

**首先我们设置，创建Class文件生成类注释模版**

**一、File >> Settings… >> Editor >> File and Code Templates**  
**找到 CSS File，并且在右边文本框中填写“\#parse(“File Header.java”)”，如下图：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center]

**二、点击Includes并且创建File Header文件，并且在右边输入框中赋值下文内容，如下图**

/**
     * @ClassName ${ PROJECT_NAME}.${ PACKAGE_NAME}.${ NAME}.java
     * @author ${ USER}
     * @version 1.0.0
     * @Description TODO
     * @createTime ${ YEAR}年${ MONTH}月${ DAY}日 ${ HOUR}:${ MINUTE}:00
     */

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 1]

**接下来我们创建方法注释模版设置**

**一、File >> Settings… >> Editor >>Live Templates**  
**然后我们创建点击右边的+号，选择第二项Group，随意起名如下图：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 2]  
![在这里插入图片描述][20201028104358293.png_pic_center]

**二、我们开始创建模版，下图：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 3]  
**三、按自己习惯写，我的**

> 注：  
> 第二步的Expand winh 是设置回车生成模版，还是Tab生成模版，或者其他按键（本人设置是回车生存模版）  
> 第一步的Abbreviation的" \* " 是在方法上输入/\*\* 然后回车生成模版

*
    * 方法描述
    * @since: 1.0.0
    $params$
    * @return: $returns$
    * @author: SongWei
    * @date: $date$ $time$
    */

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 4]  
**四、我们开始设置模板参数自动取值，点击Edit variables,如图：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 5]  
**五、直接下拉选择**

> 注：params和returns是动态获取参数的，不想动态获取参数可以不设置，要是需要动态设置的把下列参数复制到Expression中  
> params：

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) ? '\\n':'')}; return result", methodParameters())

> returns：

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())

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 6]

**以上内容我们都设置完后，现在选择那些模块生成模版。点击下方黄色警告区域,勾选java下全部内容**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/85cc6dc1b267478ebdf69ed42fbb0db9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/d2ce41ff996b48cb91c174006676cdd5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/a425a536a3c2437db0ab15278e5250a7.png
[20201028104358293.png_pic_center]: /images/20221120/c32e3e8d8b514b60b667f351027a5e59.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/36564484f90b4033a78093dbaaf0ab63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/bec7ef04f3694b52b8d88c41fb38db1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/619ece005abc41fe9d553a79acade763.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221120/6334b415ff8544d0b4af5be2285a9e64.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMTk3OTgz_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221120/9ef3f3da76ec4cbaafaba09df0d4bade.png