IDEA 设置注释设置类注释方法注释 IDEA 2022.01 设置注释

本文链接：https://blog.youkuaiyun.com/hncdyj/article/details/124624036

本文详细介绍了如何在IntelliJ IDEA中设置类注释和方法注释模板，包括文件描述模板、类描述模板和方法描述模板的创建与使用。通过设置Live Templates，可以快速生成版权信息、作者、日期等信息，提高开发效率。同时，文章提供了参数化脚本示例，用于动态填充方法参数和返回类型。此外，还提到了在使用过程中可能遇到的问题及解决办法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、类注释模板设置：File -> Settings -> Editor -> File and Code Templates -> Files

依次选择Class，Interface，Enum填入：

设置文件描述模板：

/**
 * 包名：${PACKAGE_NAME}<br>
 * 文件名：${FILE_NAME}<br>
 * 版权：Copyright by xxxx公司<br>
 * 描述：<br>
 * 修改人：${USER}<br>
 * 修改时间：${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}<br>
 * 跟踪单号：<br>
 * 修改单号：<br>
 * 修改内容：<br>
 **/

设置类描述模板

/**
 * 类描述：TODO
 *
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/

2、类注释模板设置：File -> Settings -> Editor -> Live Templates点击右边加号

新建Live Template命名为MyGroup后点击右边的加号

2.1设置类描述注释，注意模板中不能以“/”开头：

**
 *
 * @author $user$
 * @date $date$
 * @version 1.0.0
 */

①设置模板缩写名abbreviation

②设置描述Description

③编辑变量

④设置快捷键

点击④位置，设置变量赋值

2.2设置方法注释描述，注意模板中不能以“/”开头：

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

①设置模板缩写名Abbreviation
②设置描述Description
③编辑变量
④设置快捷键

点击④位置，设置变量赋值

设置params和return格式化脚本：
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());

return：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType());

3、使用注释模板

新建类可以看到，我们文件已存在我们自定文件头和类注释
在方法上按键 /* + 空格 可以直接调用出我们自定义方法注释
在类上按键 /** + Tab键 可以直接调用出我们自定义的类注释

4、相关注意，如果第3步骤无法调用注释出来

①请检查模板是否以“/”开头
②Abbreviation缩写是否以“/”开头
③实在检查不出来文件，请按以上步骤copy

一个用了11年eclipse开发JAVA老菜鸟，换了IDEA后发现没有eclipse那么方便的注释，上网百度了一遍，大部分都是互相抄，本文纯手工原创码字。

转载请注明：https://blog.youkuaiyun.com/hncdyj/article/details/124624036