idea生成类注释和方法注释的正确方法参数列表正确生成 @param

àì夳堔傛蜴生んèń 2022-10-05 03:59 320阅读 0赞

### 文章目录 ###

*   *  Intro && 效果
     *  设置面板
     *   *  对新增的模板规则，依次配置其各个选项：
         *  groovy脚本
     *  测试
     *  others

## Intro && 效果 ##

搜了很多结果，只差一点： 方法的`参数列表的注释`未正确生成。  
于是看了groovy脚本的写法，测试成功后，把写法分享出来。

效果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center]手动添加方法描述、各个参数的描述后：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 1]当在其他类中引用本方法时，看到的提示信息：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 2]  
另：[IDEA 类/接口/枚举/注解 文件模板的设置方法 注释][IDEA _ _]

## 设置面板 ##

先打开首选项设置面板：settings / preferences

`Editor` \--> `Live Templates` \--> `Java` \--> `+` \--> `Live Template`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_20_color_FFFFFF_t_70_pic_center]

### 对新增的模板规则，依次配置其各个选项： ###

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

1.  `Abbreviation` 缩写内容 `*`
2.  `Description` 随意写
3.  `Template text` 模板内容，其中用 `$varName$` 格式表示会字符串变量值。

*
     * Description TODO
     * @date $datetime$
     * @user $user$
    $paramList$ * @return $methodReturnType$
     **/

1.  `Applicable` 选 `Java`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 3]  
5. `Expand with` 修改为`Enter`，因为我是用`Enter`触发。  
6. `Edit Variables`

刚才在脚本中用到了4个自定义变量，现在要去指定这4个变量的值的规则。  
下拉框选择可以选择函数：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 4]  
其值的表格：

<table> 
 <thead> 
  <tr> 
   <th align="left">Name</th> 
   <th>Expression</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">datetime</td> 
   <td>date(“YYYY-MM-dd HH:mm:ss”)</td> 
  </tr> 
  <tr> 
   <td align="left">user</td> 
   <td>user()</td> 
  </tr> 
  <tr> 
   <td align="left">paramList</td> 
   <td>groovyScript(“def result = ‘’; def nameList = _1; for (int i = 0; i &lt; nameList.size(); i++) { def currLine = String.format(’ * @param %s %s’, nameList[i], System.lineSeparator()); result += currLine; }; return result;”, methodParameters())</td> 
  </tr> 
  <tr> 
   <td align="left">methodReturnType</td> 
   <td>methodReturnType()</td> 
  </tr> 
 </tbody> 
</table>

单行可复制：

groovyScript("def result = ''; def nameList = _1; for (int i = 0; i < nameList.size(); i++) { def currLine = String.format(' * @param %s %s', nameList[i], System.lineSeparator()); result += currLine; }; return result;", methodParameters())

你需要的参考(或直接复制以上内容，走过流程即可)：  
可用的api: [https://www.jetbrains.com/help/idea/2021.1/edit-template-variables-dialog.html\#predefined\_functions][https_www.jetbrains.com_help_idea_2021.1_edit-template-variables-dialog.html_predefined_functions]  
groovy语法：[http://www.groovy-lang.org/syntax.html][http_www.groovy-lang.org_syntax.html]  
[groovy 下载 配置环境变量 使用groovyConsole 编辑 运行 groovy 脚本][groovy _ _ _groovyConsole _ _ groovy]

### groovy脚本 ###

根据 [groovy 下载 配置环境变量 使用groovyConsole 编辑 运行 groovy 脚本][groovy _ _ _groovyConsole _ _ groovy]  
修改for循环脚本得到：

def result = ''; 
    def nameList = _1; 
    for (int i = 0; i < nameList.size(); i++) { 
        def currLine = String.format(' * @param %s %s', nameList[i], System.lineSeparator()); 
        result += currLine; 
    }; 
    return result;

其功能是将一个数组参数转换格式。

压缩脚本为一行，作为`groovyScript("xxx", methodParameters())`的参数。  
整个`groovyScript("xxx", args)`方法的返回值，作为本例中`paramList`的值。

## 测试 ##

编写方法：

public String getSomeInfo(String name, List<Integer> list, int age) throws IOException, FileNotFoundException { 
        return "";
    }

编写`/**` 然后`Enter`，结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 5]

## others ##

依旧存在的问题： 方法抛出的异常，未自动生成注释。  
形如：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 6]

*  [IDEA 类/接口/枚举/注解 文件模板的设置方法 注释][IDEA _ _]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221005/55712c3b04ea4c5ca1b1e010786e97b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221005/bb3c82a8d2cb435293b16cc0b2e25ccc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221005/9941aa126c8f4f6aa7e7186a6be3d86b.png
[IDEA _ _]: https://wuyujin.blog.csdn.net/article/details/117620844
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_20_color_FFFFFF_t_70_pic_center]: /images/20221005/64e2c18099624a4e9fcf07cf292b6c05.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_20_color_FFFFFF_t_70_pic_center 1]: /images/20221005/b350f7b78f5c4bd3aadd3702f50d15e0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221005/82c10316d9a14580b552083e66d37c2f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221005/a7923cc3640a4f51b9200631dd83a567.png
[https_www.jetbrains.com_help_idea_2021.1_edit-template-variables-dialog.html_predefined_functions]: https://www.jetbrains.com/help/idea/2021.1/edit-template-variables-dialog.html#predefined_functions
[http_www.groovy-lang.org_syntax.html]: http://www.groovy-lang.org/syntax.html
[groovy _ _ _groovyConsole _ _ groovy]: https://wuyujin.blog.csdn.net/article/details/117624363
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221005/5711584d034f46049a9b21c006e91e76.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221005/481b6ff612ca49d4bdac30250249e107.png