idea里面的注释模板

目录

• 类注释
• 方法注释

类注释

打开 IDEA 的 Settings，点击 Editor–>File and Code Templates，点击右边 File 选项卡下面的Class，在其中添加图中红框内的内容：

/**
 * @author jing
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

在这里插入图片描述

方法注释

根据形参数目自动生成 @param 注解 根据方法是否有返回值智能生成 @Return 注解 相较于类模板，为方法添加注释模板就较为复杂，首先在 Settings 中点击 Editor–>Live Templates。

点击最右边的 +，首先选择 2. Template Group… 来创建一个模板分组：

在这里插入图片描述

在弹出的对话框中填写分组名，我这里叫做 userDefine：

然后选中刚刚创建的模板分组 userDefine，然后点击 +，选择 1. Live Template：

在这里插入图片描述

此时就会创建了一个空的模板，我们修改该模板的 Abbreviation、Description 和 Template text。需要注意的是，Abbreviation 必须为 *，最后检查下 Expand with 的值是否为 Enter 键。

在这里插入图片描述

还记得我们配置 Template text 时里面包含了类似于

这样的参数，此时 IDEA 还不认识这些参数是啥玩意，下面我们对这些参数进行方法映射，让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮：

在这里插入图片描述

为每一个参数设置相对应的 Expression：

在这里插入图片描述

需要注意的是，date 和 time 的 Expression 使用的是 IDEA 内置的函数，直接使用下拉框选择就可以了，而 param 这个参数 IDEA 默认的实现很差，因此我们需要手动实现，代码如下：

param

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

return

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

注：你还注意到我并没有勾选了 Skip if defined 属性，它的意思是如果在生成注释时候如果这一项被定义了，那么鼠标光标就会直接跳过它。我并不需要这个功能，因此有被勾选该属性。

实现的效果：

在这里插入图片描述

在这里插入图片描述