IDEA配置注释模版

引言：注释是一种良好的编程习惯，含有必要信息的注释同为重要，可设定模版，自动补全注释，固化格式，统一风格。

1.类模版：

File--》setting，搜索code templates，接口、枚举都是类的延伸，可以统一模版，默认模版如下:

在public class 类名前插入：

/**

*@ClassName ${NAME}

*@Description TODO

*@Author XXXXX

*@Date ${DATE} ${TIME}

*/

接下来可以创建一个类来测试了：

2.方法注释

上述配置，生成类的时，自动注释，但是方法注释，是配置后需要出发的，并不会敲一个方法就自动在上面给添加注释，需要在方法上用关键词触发，配置方式：

输入组名，比如MethodAnnotaion，选中组名，再点击Live Template.

*
 * @Description //TODO $end$
 * @Date $date$ $time$ $param$ $return$
**/

最后点击Edit Variables，本身值：

配置值：

date = data()

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

配置后为：

核对无误点击OK，会关闭此弹窗回到上一个界面，expand with出发方式改为enter，应用范围修改为java，然后apply应用此次的配置即可：

接着，在方法上输入/**，然后enter就可以自动带出模版：

完结！

Do i explain clearly to you?ths