IDEA注释模板配置教程

IDEA注释配置教程(注释规范)v2.0

0. 修订记录

修订人	修订日期	修订版本
dolyw	2019-08-26	v1.0
...	...	...
dolyw	2022-11-09	v2.0

1. 开始配置

打开 Setting，如下图，点击 Template Group，建立一个新的分组

输入命名 MyKey 建立自己的分组，命名随意，再选择 MyKey 点击加号，点击 Live Template

输入快捷键，比如我输入的是 hd，点击下面红字盘边的 Define，选择 Java

在模板框输入下面的代码，注意空格排版，保证完全一致，也可复制 Template.json 文件内代码块

**
 * TODO: $desc$
 *
$param$
 * @return $return$
 * @throws $throws$
 * @author wliduo[i@dolyw.com]
 * @date $date$ $time$
 */

再配置对应的参数，点击 Edit variables，参数如下，复制对应参数输入后需要回车确认才会输入成功

param  : 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) ? '\\r\\n' : '')}; return result", methodParameters())
return : methodReturnType()
throws : completeSmart()
date   : date()
time   : time()
desc   : 

将 desc 移动到最下面，并且右边除了 desc 全部打钩，点击 OK 确认保存就可以了

2. 开始使用

在你的方法或者类上面直接输入 / + 你设置的Abbreviation快捷键 + 你设置的确定键就生成对应的注释了，确定键可以设置如下这些，Enter ，Space ，Tab

一般默认都是回车，所以就是输入 / + hd + 回车即可，如下输入后弹出提示，然后回车确认就好了

3. Template.json

Template.json 文件下载 (opens new window)

**
 * TODO: $desc$
 *
$param$
 * @return $return$
 * @throws $throws$
 * @author wliduo[i@dolyw.com]
 * @date $date$ $time$
 */

--------------------------------------------------
param  : 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) ? '\\r\\n' : '')}; return result", methodParameters())
return : methodReturnType()
throws : completeSmart()
date   : date()
time   : time()
desc   : 
--------------------------------------------------




**
 * $desc$
 * 
 * @author wliduo[i@dolyw.com]
 * @date $date$ $time$
 */
 --------------------------------------------------
date   : date()
time   : time()
desc   : 
--------------------------------------------------