方法一:自動生成類注釋
在創(chuàng)建類的時候项滑,自動生成類注釋卷扮,打開Settings>Editor>File and Code Templates借浊,F(xiàn)iles頁簽下,選擇Class/Interface号醉,可以看到引用了#parse("File Header.java")
模版:
所以我們來修改模版即可反症,Includes頁簽下,選擇
File Header
模版畔派,右側(cè)即自定義模版铅碍,下面的Description中描述了支持的參數(shù):配置模版如下:
/**
* @Description TODO
* @author ${USER}
* @date ${DATE}-${TIME}
*/
方法二:自定義模版生成類(方法)注釋
方法一只能在類定義時生成注釋,如果想重新定義或給方法生成注釋线椰,則需要自定義模版進行配置胞谈,打開Settings>Editor>Live Templates,自定義一個模版組憨愉,來創(chuàng)建自己的模版:
設置類注釋及參數(shù):
配置好以下內(nèi)容后烦绳,在類上方輸入/*c
,按下Enter
即可添加類注釋:
**
* $END$
* TODO
* @author $user$
* @date $date$
**/
-
參數(shù)配置:
date("yyyy-MM-dd HH:mm:ss")
配紫,設置完成后需要按Enter
鍵径密,否則無法保存。
設置方法注釋及參數(shù):
配置好以下內(nèi)容后躺孝,在類上方輸入/*m
享扔,按下Enter
即可添加方法注釋:
**
* $END$
* TODO
* @author $user$
* @date $date$
$param$
* @return $return$
**/
- ==開頭不能有
/
,否則param顯示錯誤==植袍; - 參數(shù)配置:
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())
方法三:直接替換文件
是不是稍微有點麻煩...我找到了自定義模版存放的路徑惧眠,文件名稱即為模版組名稱:
不想手動配置的朋友可以在路徑下創(chuàng)建一個
XXX.xml
文件,將下面的內(nèi)容復制保存于个,重啟一下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>