idea 配置注释模板

1、类注释：点击Setting - Editor - File and Code Templates 进行设置

/**
 * @author cc
 * @data ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

接口也可以同样设置，选择右侧Interface选择，同样设置即可。 下方Descipiton列出了所有支持的模板参数，想要配置其他参数，可以查看配置其他参数。

2、方法注释

实现：1：根据形参数目自动生成 @param 注解。2：根据方法是否有返回值智能生成 @Return 注解

点击 Setting - Editor - Live Templates ,右侧点击+号选择Template，创建一个模板分组

填写分组名称，点击ok完成。

选中新创建模板分组，点击右侧+号，Live Template

创建模板，修改该模板的 Abbreviation、Description 和 Template text。Abbreviation 必须为 *，Expand with 的值为 Enter 键。

Template text内容如下，启动第一行*顶格开头，不是/。

*
 * 
 * @author cc
 * @date $date$ $time$$param$ $return$
 */

No applicable contexts，说明此时这个模板还没有指定应用的语言，点击Define，选择java

点击Edit variables 按钮

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

date 和 time 的 Expression 使用的是 IDEA 内置的函数，使用下拉框选择就可以了。

param IDEA 默认的实现很差，我们手动实现，代码如下：

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())

 

 

点击OK保存成功。

示例：