最正确的IDEA类和方法的模板注释

1、修改类注释模板

　　选择File->Settings->Editor->File and Code Templates，在Files下分别点击class，interface，

在右侧输入框中分别加上下面的代码：

/**
* ${DESCRIPTION}
* @author [email protected]
* @date ${DATE} ${TIME}
*/

这样在下次创建类或者接口的时候，就会提示你输入类或者接口的描述，生成的类或者接口上面会自动带上作者和日期。

和Files紧挨着的includes，下有一个file header

右侧输入栏里添加下面的代码：

/**
* @description 
* @author [email protected]
* @date ${DATE} ${TIME}
*/

这种是在其他的文件头部自动生成作者时间（如果类和接口没有设置的话也会采用这种方式），描述要在生成方法后自己添加。

2.修改方法注释模板

在File->Settings->Editor->Live Templates，点击右侧加号，选择Template Group

之后选中我们刚才新建的Template group，点击右侧加号，选择live Template

之后的步骤要按照我的方式来，不然会造成在方法头部加模板注释获取不到方法的参数或者格式不对的错误

如图：

Template text 中的内容为：

* 
 * @describe $description$ 
 $params$
 * @return $returns$
 * @author [email protected]
 * @date $date$ $time$
*/

一定要是这样的格式，不然按照我后面的方法操作时格式会乱（自己有点强迫症，看不了格式乱）

之后选择下面的Define，再勾选java

之后点击Edit variables，Expression里面的下拉框按照下面的图选。params的按照下面的填写，最后点击ok。

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

这样就设计完了。

再说一下方法注释模板的使用方式：

在方法的上部，输入/**之后敲tab键，就会自动生成我们的方法模板，看到参数也自动生成了。完美。

有不懂的可以再问我。

转载请注明出处，谢谢。