IDEA如何设置类头注释、方法注释以及属性注释

IDEA如何设置类头注释、方法注释以及属性注释

  类头注释、方法注释在这类介绍有很多，而且基本一致，也很好用，但是每次需要对属性进行注释的时候都很麻烦。因此不得不花时间进行调整。因此记录下来，以备后续使用。

1 类头注释 

打开设置面板，然后填写注释模板：

File  => setting  => editor =>  File and Code Templates

/**
 * TODO 类描述
 * @author Anna.
 * @date ${DATE} ${TIME}
 */

2 属性注释/方法注释创建流程

2.1 第一步勾选Enable  Live  Templates

File  => setting  => editor =>  File and Code Templates

2.2 第二步新建一个Group

以上基本流程与网络上各位大佬介绍基本一致

2.3 第三步新建一个Template

选中新建的group，也就是选中chenjieGroup，在这个group下新建一个LiveTemplate

2.3.1 方法注释

**
 * 功能描述
 *
$params$ 
 * @return $return$
 * @author Anna.
 * @date $date$ $time$
 */

  

参数设置：

时间设置不说了，参数设置介绍网络上大佬总结的

（1）如果param参数使用默认的methodParameters()来获取方法参数值，其注释参数是在一行展示的，如下图。这里我们希望像MyEclipse中一样，一行一个参数的样式，可以通过脚本来实现。将以下脚本复制进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) ? '\\r\\n' : '')}; return result", methodParameters())

（2）如果return参数使用默认的methodReturnType()来获取参数值，模板里使用了@link来跳转结果类型，那么当方法返回值为void时，注释会报错，如下图。可以通过脚本来避免，将上面模板中的@link参数去掉，将以下脚本复制进Expression：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

属性注释设置

相当与重新添加一个模块,设置如下：

**
 * 
 * TODO 属性描述
 */

3 使用方法

与常用操作快捷方式一样 

属性注释:  “/*” + enter

方法注释: “/**” + enter