IntelliJ IDEA 自定义注释模板配置(外部调用 params,return,正确使用javadoc格式进行注释)

第一步:点击左上角的File 选择Settings 打开设置页面 (或者直接按Ctrl + Alt + s 快捷键打开)

图-1

第二步: 在Settings 设置页面的 Editorlan 栏目下找到 Live Templatea 点击打开自定义注释设置页面

图-2

第三步:点击列表右边的绿色+号会有两个选项: 1: Live Template (创建一个动态模板) 2: Template Group... (添加一个模板类目) 

图-3

第四步: 如图我们点击2: Template Group... 创建了一个名为 zxl 的模板类目。在该类目下点击+号选择1: Live Template 添加模板:

图-4

图-4中标注:

1. 模板的缩写 
2. 模板的描述
3. 模板的内容
4. 设置模板中的自定义参数
5. 选择模板的触发方式

Template text 内容如下:

*
 * 功能描述: 
 * 〈$END$〉
 * 
 $params$
 * @return : $return$
 * @author : zxl
 * @date : $DATE$ $TIME$
 */

(这里开头用了 * ,而没有使用 /** 是为了从函数外部调用 params 和 return , <$END$> 表示最后输入位置)

第五步: 点击 Edit variables , 进行自定义参数配置 

图-5

上图-5中标注:

1. 自定义参数名称
2. 参数表达式
3. 是否跳过定义

在这里我们把4个参数的 Skip if defined 都勾选上,是为了模板生成后直接跳转到功能描述:进行书写。

params表达式内容如下:

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

第六步: 选择触发方式, 如 图-6 我们这里选择回车。最后依次保存配置 -> 完成!

图-6

使用方式: 在函数上一行输入/** + 回车 (无需输入函数名)输出如下:

由于@param 格式要求为 : @param 参数名 参数说明  

如果直接使用提供的methodParameters()会一直报错,所以我再后面追加了一个参数说明标识:代表第几个参数。实现方式可查看自定义参数params的表达式。不足之处,欢迎大家评论!