idea配置方法注释(多个参数)

从eclipse转idea过程中,真的是遇到很多不习惯不舒服的地方.比如说文档注释,在这里记录下我的曲折的经历
得益于各位大神的总结,基本的类注释和方法注释的配置方法很容易找到,也都能配置好. 但是,按照其他人的方式,方法的参数是这种形式的:

@param [pa1,pa2]

这种形式很不友好,我想要的是下面这种

@param pa1
@param pa2

经过尝试,发现脚本可以解决,我用的脚本如下:

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {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())

然后效果就是这个样子:

image.png

下面是一些具体的配置:

一、类注释

Preferences-->Editor-->File and Code Templates,然后点击file header进行编辑即可

类注释

各个参数的意义在下方都有解释.
着重说一点:

${time} : 在mac的系统下,显示的是 “下午 2:20” //不太喜欢这种形式
${hour}:${minute} :显示的是 14:20

二、方法注释(重点)

方法注释1

(1)添加模版

Preferences-->Editor-->Live Template
1.点击右上角的➕,先建一个template group,名字随便取,我这里叫“my group”
2.然后同样的➕,建一个模版live template
命名和描述自己填,我这里为什么取名为“*”,是有原因的:
idea中,添加方法注释的快捷键为:

/*+模版名 +tab

为了沿用eclipse的习惯,/**+Enter可以生成注释,所以

·把模版名叫“ * ”;
·然后如图,将右下角的Options--> Expand with Tab 改成Enter

这样就可以了.

另外,有的地方说在方法上一行直接写模版名称,通过联想功能添加注释.但是这种方法添加的注释,不能自动添加@param

(2)注释文本填写:

*
 * 
 *
 * @author junguo.fan
 * @version $data$ $time$ 
$param$
 * @return $return$
 */

注意:

第一行是一个* ,而不是/** .否则使用上面的快捷键的时候,会变成这种情况

/*/**

接下来就是编辑变量了,点击上图中的Edit variables,就可以对上面填写的变量进行编辑了

编辑变量

关于param的groovy脚本,文章开头已经提到了.直接展到方法,然后回车即可

新增:

在使用idea的时候,发现鼠标移到方法上之后,只显示方法的名字、返回值等基本信息,不显示方法注释.经过搜索,发现是idea默认不显示源码和源码注释的,需要自己设置一下:

image.png

然后重新引入包(重新下载即可)

最后编辑于：2020.04.05 14:05:55