IDEA类和方法注释模板设置（非常详细）

参考博客：

https://www.cnblogs.com/wang3680/p/12394053.html

 

一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件（当然你要设置接口的还也可以选择Interface文件）

 

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#parse("File Header.java")

/**

*@ClassName ${NAME}

*@Description TODO

*@Author ${USER}

*@Date ${DATE} ${TIME}

*/

public class ${NAME} {

}

 

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是

/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

 

java方法注释-快捷键为:/**+enter

*
* @Author $user$
* @Description $Desc$ TODO
* @Date $date$ $time$
* @Param $param$
* @return $return$
**/

 

 

 

 

 

 

—class

/**

*@ClassName ${NAME}

*@Description TODO

*@Author ${USER}

*@Date ${DATE} ${TIME}

*/

public class ${NAME} {

}

 

 

 

method comment

 

*

* @Author $user$ 

* @Description $Desc$ TODO

* @Date $date$ $time$

$params$

* @return $return$

**/

 

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