Idea配置Javadoc

方法一:自動生成類注釋

在創(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)建自己的模版:


創(chuàng)建自定義模版組

創(chuàng)建自定義模版

設置類注釋及參數(shù):

配置好以下內(nèi)容后烦绳,在類上方輸入/*c,按下Enter即可添加類注釋:

**
 * $END$
 * TODO
 * @author $user$
 * @date $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顯示錯誤==植袍;
  • 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="**&#10; * $END$&#10; * TODO&#10; * @author $user$&#10; * @date $date$&#10; **/" shortcut="ENTER" description="類注釋" toReformat="false" toShortenFQNames="true">
    <variable name="user" expression="user()" defaultValue="" alwaysStopAt="true" />
    <variable name="date" expression="date(&quot;yyyy-MM-dd HH:mm:ss&quot;)" defaultValue="" alwaysStopAt="true" />
    <context>
      <option name="JAVA_CODE" value="true" />
    </context>
  </template>
  <template name="*m" value="**&#10; * $END$&#10; * TODO&#10; * @author $user$&#10; * @date $date$&#10; $param$ &#10; * @return $return$&#10; **/" shortcut="ENTER" description="方法注釋" toReformat="false" toShortenFQNames="true">
    <variable name="user" expression="user()" defaultValue="" alwaysStopAt="true" />
    <variable name="date" expression="date(&quot;yyyy-MM-dd HH:mm:ss&quot;)" defaultValue="" alwaysStopAt="true" />
    <variable name="param" expression="groovyScript(&quot;def result=''; def params=\&quot;${_1}\&quot;.replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i &lt; params.size(); i++) {result+='* @param: ' + params[i] + ((i &lt; params.size() - 1) ? '\\n ' : '')};return result&quot;, methodParameters())" defaultValue="" alwaysStopAt="true" />
    <variable name="return" expression="methodReturnType()" defaultValue="" alwaysStopAt="true" />
    <context>
      <option name="JAVA_CODE" value="true" />
    </context>
  </template>
</templateSet>
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末氛魁,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子厅篓,更是在濱河造成了極大的恐慌秀存,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,214評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件贷笛,死亡現(xiàn)場離奇詭異应又,居然都是意外死亡,警方通過查閱死者的電腦和手機乏苦,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評論 2 382
  • 文/潘曉璐 我一進店門株扛,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人汇荐,你說我怎么就攤上這事洞就。” “怎么了掀淘?”我有些...
    開封第一講書人閱讀 152,543評論 0 341
  • 文/不壞的土叔 我叫張陵旬蟋,是天一觀的道長。 經(jīng)常有香客問我革娄,道長倾贰,這世上最難降的妖魔是什么冕碟? 我笑而不...
    開封第一講書人閱讀 55,221評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮匆浙,結果婚禮上安寺,老公的妹妹穿的比我還像新娘。我一直安慰自己首尼,他們只是感情好挑庶,可當我...
    茶點故事閱讀 64,224評論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著软能,像睡著了一般迎捺。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上查排,一...
    開封第一講書人閱讀 49,007評論 1 284
  • 那天凳枝,我揣著相機與錄音,去河邊找鬼雹嗦。 笑死范舀,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的了罪。 我是一名探鬼主播锭环,決...
    沈念sama閱讀 38,313評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼泊藕!你這毒婦竟也來了辅辩?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,956評論 0 259
  • 序言:老撾萬榮一對情侶失蹤娃圆,失蹤者是張志新(化名)和其女友劉穎玫锋,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體讼呢,經(jīng)...
    沈念sama閱讀 43,441評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡撩鹿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,925評論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了悦屏。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片节沦。...
    茶點故事閱讀 38,018評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖础爬,靈堂內(nèi)的尸體忽然破棺而出甫贯,到底是詐尸還是另有隱情,我是刑警寧澤看蚜,帶...
    沈念sama閱讀 33,685評論 4 322
  • 正文 年R本政府宣布叫搁,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏渴逻。R本人自食惡果不足惜疾党,卻給世界環(huán)境...
    茶點故事閱讀 39,234評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望惨奕。 院中可真熱鬧仿贬,春花似錦、人聲如沸墓贿。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽聋袋。三九已至,卻和暖如春穴吹,著一層夾襖步出監(jiān)牢的瞬間幽勒,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評論 1 261
  • 我被黑心中介騙來泰國打工港令, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留啥容,地道東北人。 一個月前我還...
    沈念sama閱讀 45,467評論 2 352
  • 正文 我出身青樓顷霹,卻偏偏與公主長得像咪惠,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子淋淀,可洞房花燭夜當晚...
    茶點故事閱讀 42,762評論 2 345

推薦閱讀更多精彩內(nèi)容