IntelliJ IDEA 添加类、方法注释

一、类注释

1、打在IntelliJ IDEA 2022.3.1 > 按Ctrl+Alt+S > 点开 编辑器 > 选择文件和代码模板

2、找到Class、Interface、Enum项，添加注释代码

3、加入以下模板

/**
 * 
 * @author 冰鼠
 * @date ${DATE} ${TIME}
 * @version v1.0.1
 * @package ${PACKAGE_NAME}
 * @copyright 冰鼠
 */

二、方法注释（可放弃，因为系统默认有生成注释功能可查看第四点）

1、点开：实时模板 > 点击右侧：+ > 选择：模板组 > 输入mygroup > 确定，如下图

2、点开：实时模板 > 点击右侧：+ > 选择：实时模板 > 确定

缩写：*

描述：添加注释

模板文本：

/**
 *
$params$
 * @return $returns$
 * @author 冰鼠
 * @date $date$ $time$
 */
 

3、编辑变量

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：methodReturnType()
date：date()
time：time()

4、定义适用上下文，选择java全部，如下图

三、配置提示参数

1、勾选：悬停时显示快速文档

2、勾选：以下时间后显示文档弹出窗口：1000毫秒

3、勾选：补全时显示型参名称提示；
勾选：以下时间后显示形参信息弹出窗口：1000毫秒
勾选：显示完整的方法签名


四、使用注释

类注释 - 创建类时自动添加

方法注释 -
系统：方法前面，输入/** 后回车即可生成系统注释
自定义：没有注解@的方法前面，或者 方法 } 后面，输入rem 后回车即可生成自定义注释；测试有注解时无法读取参数和返回值类型