IDEA设置模板注释

IDEA设置模板注释

 

设置类文件模板注释

类文件包含class、interface、enum、@interface

首先是点击File，在下拉列表中选择Setting选项

在弹出窗口选择Editor选项下的File and Code Template选项，在右侧选择includes选项卡下的File Header选项

想要知道我们编写类文件模板注释可以使用哪些变量可以参考当前窗口右侧下方Description中提供的变量

在此窗口提供的模板注释地方填入如下信息

/**

* 文件描述

*

* @author hongwei.lian

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

*/

点击Apply，最后点击OK即可

尝试新建一个Java Class文件

输入类名，点击OK即可

生成的Java Class文件描述如下：

 

设置方式模板注释

专指method

首先是点击File，在下拉列表中选择Setting选项

在弹出窗口选择Editor选项下的Live Template选项，在右侧点击绿色的+号，在出现的两个下拉列表选项中选择Template Group

输入Template Group名字，点击OK

选中刚才新建的Template Group，点击右侧的+号，在出现的两个下拉列表选项中选择Live Template

输入快捷键名称，点击最下方的Define，在列表中选择Java

在提供的空白处输入以下内容：

* 方法描述

*

$params$

* @author hongwei.lian

* @date $date$ $time$

*/

因为编辑的部分存在三个变量，也就是$$包裹的变量名称，这时候后侧的Edit variables才可以编辑，点击编辑

按照如下编写：

说明：

1、对于params做特殊处理，表达式部分空着不填，默认值部分则写入如下一段groovy语言编写的代码，groovy语言是兼容Java语言的，很好理解下面这段代码，

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

为何要做特殊处理呢，因为IDRA提供的变量

呈现出的是一个数组形式的参数列表，

而我们需要的形式

以上做法便是提供出这样的模板注释

2、对于date和time我们直接选择IDEA提供的表达式

和

点击OK，应用

在方法上面我们先输入/**再按我们设置的快捷键jm+Enter即可生成方法注释

如下：

 

这才是自己想要的模板注释，类似Eclipse风格的