代码注释配置教程-适用于IntelliJ IDEA编辑器

IDEA 注释模板

分为两部分：方法的注释和类的注释。方法的注释需要在方法内部手动输入comment，按回车生效；类的注释自动生成，只需要手动输入类的说明信息即可。

方法注释模板

1. 进入settings->Editor->Live Templates

2. 点击最右边的“+”按钮，选择“Template Group”。

3. 在弹出的对话框中输入group名后，鼠标选中刚刚创建的group，再次点击右边的“+”按钮，选择“Live Template”。

4. 在"Abbreviation"中输入comment，下面的"Template text"中输入：

/**
* 方法描述:
* @author $user$ $date$ $time$
$params$
* @return 
* @modificationHistory=========================逻辑或功能性重大变更记录
* @modify by user: {修改人} $date$ $time$
* @modify by reason:{原因}
*/

5. 如下图所示：

6. 点击上图右边的Edit variables按钮， 在弹出的对话框中，找到param行，并在"param"行的"Expression"列中中输入如下内容：

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

7. 如下图所示：

8. 一路点击"OK"按钮后，在需要给方法添加注释的地方，进入到方法中，然后输入comment，按回车就会出现注释，剪切再粘贴到方法之上就完成了方法的注释

新建类注释模板

1. 进入Settings->Editor->File and Code Templates，选择"includes"标签，下面选择"File Header"

2. 在右边的输入框中输入：

/**
* <p>类说明：</p>
* @author ${USER} ${DATE} ${TIME}
* @version v1.0
* @modificationHistory=========================逻辑或功能性重大变更记录
* @modify by user: {修改人} ${DATE} ${TIME}
* @modify by reason:{方法名}:{原因}
*/

3. 一路点击"OK"按钮后，新建一个类，可以看到已经自动生成了类的注释。这里需要对"类说明"删除并填上类的说明信息。