IntelliJ IDEA自定义类和方法注解模板

现在Java开发主流工具应该是Intelij Idea 方便快捷.

本文将主要介绍如何用Intelij Idea配置类及方法的注释模板提高代码注释效率

1. 配置类注解模板

找到配置页面 File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

将类注释模板替换为如下(也可以自己自定义)：

   /**

    * @Title: ${NAME}

    * @ProjectName ${PROJECT_NAME}

    * @Description: TODO

    * @author ${USER}

    * @date ${DATE} ${TIME}

    */

配置如下：

2. 配置方法模板

找到配置页面File->Setting->Editor->LiveTemplates点击右边上面那个绿色的+号，选择Template Group双击，然后弹出一个窗口，随便添加一个名字，

我这里添加的是MyGroup 然后点击OK.

选中刚才创建的myGroup，然后再次点击右侧的绿色+，这次选择的是第一个1. Live Template。取名为*，取名可以随便，只是个人觉得方便，你可以取别的。

添加如下模板：

*

* @Description: TODO

$param$

* @return $return$

* @exception $exception$

* @author mazhq

* @date $date$ $time$

*/

　1 点击Define 然后选择 Everywhere

注意：只有当变量被$$包围时右侧的Edit variables才可以点击哦。
2 再编辑好模板之后就只为参数添加$$添加变量，点击右侧的 Editor variables：

param里面添加：

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\\t' : '')}; return result", methodParameters())

3 完成之后点击Apply然后点击OK，注意了，重点的地方，在你的方法上输入 /*然后加上模板的名称*，这就是我为什么不取字母而取名为*，因为这样很快速，再按Tab键（注意啊不是按Enter键，而是按Tab键）就会出现你想要的注释了，很多教程是直接输入模板名称按tab键，但是这种方法的@param和@return是获取不到的，再重复一遍正确的方式：/** 然后按Tab键；如果你取名为abc那就是 /*abc 然后按Tab。

也可以设置成Enter：

4. 配置完成啦效果如下：

新建类注解:

方法注解：

俩字：完美

巴特西

IntelliJ IDEA自定义类和方法注解模板

最新文章

热门文章