IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。

IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。

IDEA好用到爆炸。

1. 开启鼠标悬停显示方法注释

进入idea进行设置:(ctrl + alt + s) setting -> Editor -> General -> Show quick documentation on mouse move

IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第1张图片

2. 类、接口、枚举、、注解, 模板注释设置

/**
 * @Author: ZhiHao
 * @Date: ${DATE} ${TIME}
 * @Description: 
 * @Versions 1.0
 **/

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

3. 方法模板注释设置

IDEA依次选择点击:File --》 Settings --》 Editor --》 Live Templates --》点击右侧+号 --》Template Group --》输入myTemplates --》确定
–》选中myTemplates -->点击右侧+号 --》Live Template

原封不动复制如下模板代码

** 
 * $description$ 
 * $params$ 
 * @return $returns$ 
 * @author: ZhiHao
 * @date: $date$ 
 */

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

IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第2张图片

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

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i]!= null && !''.equals(params[i])){if(i == 0){result+='\\n'}; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}}; if(result!= null && !''.equals(result)){return result}", methodParameters())

上面的groovyScript的代码主要作用是判断方法是否有参数,如果没有将不输出,有就将参数分行进行展示。

设置完毕后,先输入/* 在按Tab键呼出注释:

IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第3张图片

参数没有是不会输出注释的。
如果觉得返回注释格式不好看,想要不带包名的,可以使用下面的。
先替换成下面的。

** 
 * $description$ 
 * $params$ $returns$ 
 * @author: ZhiHao
 * @date: $date$ 
 */

然后返回值那里替换成

groovyScript("def result=''; def params=\"${_1}\"; if(params.indexOf('<') != -1){params=params.substring(0,params.indexOf('<'));}; def list=params.split('\\\\.').toList();if(list !=null && !'void'.equalsIgnoreCase(list.get(list.size-1))){result+='\\n'+' * @return '+list.get(list.size-1);return result}", methodReturnType())

IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第4张图片

最终效果图是这样的, 返回值说void则没有return注释, 有返回值没有包名。
IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第5张图片
在或者返回参数带包名, 只判断是否是void,是就不加返回注释。复制以下代码。

groovyScript("def result=\"${_1}\"; if(result !=null && (result.indexOf('void')== -1)){result='\\n'+' * @return '+result;return result}", methodReturnType())

效果图
IDEA注释模板设置,方法参数分行,鼠标悬停显示方法注释。_第6张图片

你可能感兴趣的:(IDEA,intellij,idea,IDEA方法完美注释)