方法一:自动生成类注释
在创建类的时候,自动生成类注释,打开Settings>Editor>File and Code Templates,Files页签下,选择Class/Interface,可以看到引用了#parse("File Header.java")
模版:
所以我们来修改模版即可,Includes页签下,选择
File Header
模版,右侧即自定义模版,下面的Description中描述了支持的参数:配置模版如下:
/**
* @Description TODO
* @author ${USER}
* @date ${DATE}-${TIME}
*/
方法二:自定义模版生成类(方法)注释
方法一只能在类定义时生成注释,如果想重新定义或给方法生成注释,则需要自定义模版进行配置,打开Settings>Editor>Live Templates,自定义一个模版组,来创建自己的模版:
设置类注释及参数:
配置好以下内容后,在类上方输入/*c
,按下Enter
即可添加类注释:
**
* $END$
* TODO
* @author $user$
* @date $date$
**/
-
参数配置:
date("yyyy-MM-dd HH:mm:ss")
,设置完成后需要按Enter
键,否则无法保存。
设置方法注释及参数:
配置好以下内容后,在类上方输入/*m
,按下Enter
即可添加方法注释:
**
* $END$
* TODO
* @author $user$
* @date $date$
$param$
* @return $return$
**/
- ==开头不能有
/
,否则param显示错误==; - 参数配置:
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())
方法三:直接替换文件
是不是稍微有点麻烦...我找到了自定义模版存放的路径,文件名称即为模版组名称:
不想手动配置的朋友可以在路径下创建一个
XXX.xml
文件,将下面的内容复制保存,重启一下Idea就可以直接使用了:
<templateSet group="dragon">
<template name="*c" value="** * $END$ * TODO * @author $user$ * @date $date$ **/" shortcut="ENTER" description="类注释" toReformat="false" toShortenFQNames="true">
<variable name="user" expression="user()" defaultValue="" alwaysStopAt="true" />
<variable name="date" expression="date("yyyy-MM-dd HH:mm:ss")" defaultValue="" alwaysStopAt="true" />
<context>
<option name="JAVA_CODE" value="true" />
</context>
</template>
<template name="*m" value="** * $END$ * TODO * @author $user$ * @date $date$ $param$ * @return $return$ **/" shortcut="ENTER" description="方法注释" toReformat="false" toShortenFQNames="true">
<variable name="user" expression="user()" defaultValue="" alwaysStopAt="true" />
<variable name="date" expression="date("yyyy-MM-dd HH:mm:ss")" defaultValue="" alwaysStopAt="true" />
<variable name="param" 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) ? '\\n ' : '')};return result", methodParameters())" defaultValue="" alwaysStopAt="true" />
<variable name="return" expression="methodReturnType()" defaultValue="" alwaysStopAt="true" />
<context>
<option name="JAVA_CODE" value="true" />
</context>
</template>
</templateSet>