【IDEA中自定义设置类注释和方法注释】

IDEA中自定义设置类注释和方法注释

---

---

前言

编码养成注释的好习惯，于人于己都有利无害。利用工具配置好注释模版，添加注释也能变得很简单。

---

一、类注释

选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

以下为我的注释配置：

/**
* @program: ${PROJECT_NAME}
* @packagename: ${PACKAGE_NAME}
* @classname: ${NAME}
* @author: ljxz
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @description: ${NAME}
**/

右下角官方给提供了一些注释模板，如需要可以自定义，然后点击 OK 或者 Apply 按钮。此后当在idea中创建一个类文件时，会默认添加上述注释，需要的话更改描述即可。

二、方法注释

1. 同样选择File→Settings→Editor→Live Templates。点击右边的加号，选择第二个 Template Group，创建一个分组。
   
2. 弹出创建组的框，定义一个名称，点击 OK。先选中刚创建的组名，再点击右边 + 号，选择第一个 Live Template，创建一个模板。
   
3. 其中：<abbreviation>填模板的缩写，也可以认为是设置的快捷键，可以使用**号作为代号，方便后面调用模板。
4. Options→Expand with：填注释模板的扩展快捷键，这里使用默认的Tab。
5. Template text：填写注释模板的内容。参数名使用${参数名}$的格式。（注意：注释模板开头的/不要填写，否则会出现param为null的情况，这个我在试的时候被坑了）

注释模板的内容如下：

**
* @name: $description$
* @param: $params$ 
* @return: $return$ 
* @author: ljxz 
* @date: $time$ $date$
* @description: $description$
*/ 

如下图所示

6. 然后点击上图所示的 Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。如图所示，需要哪个注释模板就在后面打钩，每个参数官方都给提供参数了，点击箭头所指的下拉可以选择。
   
   其中 params 可以用默认的，也可以自定义。默认所有参数在一行展示，如需自定义 params ，将下面的代码复制到 Expression 下的 params里面，请自测。

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

7. 点击模板页面最下方的警告define，来设置将模板应用于Java及其所有子元素。
   
8. 创建一个方法测试，在方法上输入/** 然后使用Tab键即可使用刚配置的模版添加上注释。效果如下。
   

---

总结

工欲善其事，必先利其器。