idea自定义类注释模板和方法注释模板,并完美解决空参数,无返回值的方法注释模板

女爷i 2023-07-25 08:41 35阅读 0赞

### 从网上找的方案,总是各种各样的问题,比如空参数方法还有@param,无返回值还有@return.自己摸索了一下,并完美解决这些问题 ###

*  修改idea自带类注释模板
 *   *  进入设置File->Settings
     *  修改自带类注释
     *  应用模板.这一步基本不用改,自带的就是这样.
     *  测试.创建新类注释按照模板方式自动添加
 *  自定义方法,类注释版本
 *   *  进入设置File->Settings
     *  创建模板组
     *  输入名称,保存
     *  创建模板
     *  输入模板参数
     *  应用模板
     *  勾选后效果图
     *  再添加一个模板(应用模板和上面的一样)
     *  测试
     *   *  类注释设置的abbreviation(缩写)和Expand with是\*和Tab
         *  效果
         *  方法注释设置的abbreviation(缩写)和Expand with是\*\*和Tab
         *  效果
     *  美中不足.无参或者无返回值仍会占用一行注释

# 修改idea自带类注释模板 #

## 进入设置File->Settings ##

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

## 修改自带类注释 ##

**5下面的红框是可用参数.因为$\{USER\}不好用,我这里直接设置的作者,没有使用参数形式**

/**
     * TODO
     *
     * @author fan
     * @date ${ DATE}
     */

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

## 应用模板.这一步基本不用改,自带的就是这样. ##

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

## 测试.创建新类注释按照模板方式自动添加 ##

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

# 自定义方法,类注释版本 #

## 进入设置File->Settings ##

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

## 创建模板组 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 2]

## 输入名称,保存 ##

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

## 创建模板 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 3]

## 输入模板参数 ##

**说明**

*  1和7是注释的组合快捷键,在\*\*后按制表符Tab会触发该注释
 *  4弹出框中输入5的内容,6保存

**第3步内容**

**
     * TODO
     *
     * $params$
     * $return$
     * @author $user$
     * @date $date$
     */

**第5步中方法参数params内容**

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

**第5步返回值return内容(我这里是如果有返回值有添加@return)**

groovyScript("def result=''; def returnType=\"${ _1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '');if('void'!=returnType){result='@return '};return result", methodReturnType())

**有些人想添加@return 返回值类型;如下**

groovyScript("def result=''; def returnType=\"${ _1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '');if('void'!=returnType){result='@return ' + returnType};return result", methodReturnType())

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 4]

## 应用模板 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 5]

## 勾选后效果图 ##

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

## 再添加一个模板(应用模板和上面的一样) ##

**如果添加模板,模板之间的abbreviation不能一样**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 7]

## 测试 ##

### 类注释设置的abbreviation(缩写)和Expand with是\*和Tab ###

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

### 效果 ###

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

### 方法注释设置的abbreviation(缩写)和Expand with是\*\*和Tab ###

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

### 效果 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 8]

## 美中不足.无参或者无返回值仍会占用一行注释 ##

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

[20200413155544946.png]: /images/20230528/d8083a77b9d04403b12a8b4a59f31452.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70]: /images/20230528/ceef7a7f090f445283208b4ff4d6418f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 1]: /images/20230528/d8c4901bfb684982819ac0f674d0d194.png
[20200413155752293.png]: /images/20230528/2d6976f85751413580d571d247917827.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 2]: /images/20230528/c752b5f555e945518f34296d91ccfd3d.png
[20200413180921675.png]: /images/20230528/0875e8f02d114704b2230a17a7659e8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 3]: /images/20230528/f07343162dca457e996ebd68a59a374b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 4]: /images/20230528/145f658df64a4daabe338ffe0cf618b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 5]: /images/20230528/7549907dffd947c78e2c2dfb90d4a082.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 6]: /images/20230528/38ea1e68cf4a4a51b2a28f8e8b1b26aa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 7]: /images/20230528/2b88b7d48af24bdea32c7952239f3668.png
[2020041318451383.png]: /images/20230528/1e0de17396ff4848a8ca2d7a93f00a7a.png
[20200413184537513.png]: /images/20230528/64ed704c00d448ce9972a1ad3171b2ba.png
[2020041318514376.png]: /images/20230528/488b80a9d5394831bdd0f061f88f487d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RoYmZqaA_size_16_color_FFFFFF_t_70 8]: /images/20230528/d3a34073571e448da3fec0efd75d0cf3.png
[20200413192312117.png]: /images/20230528/4176dee9a2ec486eb166d529e85006bc.png