IDEA注释模板完美设置，参数分行，鼠标悬停显示方法注释

从Eclipse阵营转化到 IDEA,想设置一个注释模板，网络上的一些方法最大的缺陷，就是鼠标悬停在方法上无法像默认的方法注释一样显示 注释的内容，同时参数是在一行上，不能分行显示，默认的注释又没有 “时间“，”作者”等相应的注释信息。

一、类模板注释设置

IDEA依次选择点击：File --》 Settings --》 Editor --》 Code Style --》 File and Code Templates --》Class

有的版本的IDEA 找不到 Settings的 ，比如我的

125603412.png

找不到Settings 请按快捷键 command + "," 呼出如下界面

125651107.png

设置类注释模版，点击ok

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 */

生效后再新增的类注释会自动添加

/**
 * @Auther: huangfeixiang
 * @Date: 2019-01-16 15:08
 * @Description:
 */
public class test {
}

二、方法模板注释设置
正常情况想要鼠标放在方法上悬停时显示注释，需要如下设置

125578939.png

设置之后，鼠标悬停在方法上，会出现相应的注释

125642675.png

如果不需要鼠标悬停显示注释可以忽略上面的步骤

IDEA依次选择点击：File --》 Settings --》 Editor --》 Code Style --》 Live Templates --》点击右侧+号 --》Template Group --》输入myGroup --》确定
--》选中myGroup -->点击右侧+号 --》Live Template

如果找不到，请使用 command +“,” "myGroup" 可以自己定义

125579322.png

原封不动复制如下模板代码，达到最好的显示效果

**
 *
 * @date $date$ $time$
 * @author $user$                
$params$
 * @return $returns$
 */

粘贴上面的方法模版代码后，设置呼出快捷键，可以自定义，这里先设置为 “**” ，和Eclipse 呼出方法一样，然后点击 “Define”，并选中全部，也可以只选 “Java” 可以按 “Change” 更换，确定点击OK

125579596.png 125632267.png

点击 Edit variables

125632438.png

按照下图设置对应的Expression，其中 params 设置需注意，请参考下面的代码直接复制后点击ok

125615515.png

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

上面的groovyScript的主要作用是把 params 分行进行展示

设置完毕后，按快捷键 “/**/” 呼出注释：

 /**
     * 测试方法
     * @date 2019-01-16 18:56
     * @author huangfeixiang
     * @param name 参数名称
     * @param password 参数密码
     * @return java.lang.String 返回String
     */
    public static  String testAdd(int name, int password)
    {
        return "";
    }

同时鼠标悬停在方法名称上，会自动显示该方法的注释

如果不按照上述设置，网络上常见的模版，也是可以设置注释，但是鼠标悬停时无法完整正确显示注释

**
*@Description $description$
*@Param $params$
*@Return $returns$
*@Author $user$
*@Date $date$
*@Time $time$
*/

这个params 如果如下图设置

125652763.png

呼出注释快捷后，如下图显示，方法注释则不会分行显示，并且鼠标悬停的方法注释基本没有显示

125605461.png

建议使用第一种方案