Java五十二：IDEA 中自动生成类和方法头注释的详细设置及解决WrongTag报警问题

原创已于 2022-02-02 21:46:05 修改 · 2.2k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#idea #java

于 2021-09-14 11:06:52 首次发布

程序工具笔记专栏收录该内容

18 篇文章

订阅专栏

本文档详细介绍了如何在IDE中设置类头和方法头的注释模板，包括设置类头注释的 ClassName、author、version 和 Description，以及方法头注释的 title、Description、参数和返回值。此外，还提供了解决方法头注释警告的方法，并分享了参数设置的groovyScript代码。通过这些设置，可以提高代码注释的规范性和效率。

一、类头注释设置

步骤7中的代码为

/**
 *@ClassName ${NAME}.java
 *@author （写上自己的名字）
 *@version 1.0.0
 *@Description TODO
 *@CreateTime ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:00
 */

要把步骤 8 中的代码换成步骤 6 中的名字

二、方法头注释设置

设置框 5 处和 8 处的组合是调出方法头注释的快捷键
因为5处设置的是 +，所以再调用时，可以输入/+，然后按回车，效果就和javadoc代码注释的标准样式就对应了
设置框 6 处的代码为：
```
*
 * @title $title$
 * @Description $description$
 * @author nanxu 
$param$
 * @return $return$
 * @throws $throws$
 * @CreateTime $date$ $TIME$ 
 */
```
3.1 注意：开头是 ** ，不能是 /**
3.2 $param $必须顶头写，因为在第5步中对于param的设置中已经包含了对 “ *param ”头的格式设置

4.设置各注释类型的参数设置各注释类型的参数
设置各注释类型的参数

设置框 9 中 param 的参数代码如下：

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

三、解决方法头注释报警Wrong Tag的问题