IDEA类、方法注释自动生成设置
创建文件自动生成类注释设置
打开 File -> Setting -> Editor -> File and Code Templates
选择对用想要修改的文件类型,如 java 的 class 文件
然后在右侧进行基本设置,可以直接在类名上方进行注释的添加
模板内容如下:
/**
* @ClassName ${NAME}
* @Date ${DATE} ${TIME}
* @Author Kong_qy
* @Description TODO
*/
最终效果如下:
也同样可以在上述设置界面,对其他文件类型进行同样注释添加,如 Scala 文件等
通过 /** + TAB 获取方法注释设置
打开 File -> Setting -> Editor -> Live Templates
点击右边的 + 号,先添加一个 Group,这里取名为 MyGroup,然后再添加一个 Templates,名字随意,这里采用 * 号
简单介绍,右侧 Options 内,Expand with为自动生成快捷方式选项,默认为 TAB
下方内容如下设置
*
* @MethodName: $title$
* @Description:
* @Author: Kong_qy
* @Date: $DATE$ $TIME$
* $VAR1$
$params$ * @return $returns$
*/
复制完成后,点击右侧 Edit variables 进行设置
Expression 栏内容,可以通过点击下拉框进行选择即可
VAR1 的位置,具体代码如下
groovyScript(" def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i!=0)result+= ' * '; result+='@param ' + params[i] + ': ' + ((i < (params.size() - 1)) ? '\\n' + '\\t' : ''); }; return result", methodParameters())
设置完成后,在方法体上,输入 /** + TAB,即可达成以下效果