IntelliJ IDEA如何設(shè)置注釋模板

類的注釋模板

1.選擇菜單File->Settings->Editor->File And Code Templates->Includes->FileHeader,在右邊的編輯框中設(shè)置自定義的注釋模板,示例如下:

/**
*@desc  
*@author wunian
*@date ${DATE}
*/

注意從第二行開始的*不要縮進(jìn),否則創(chuàng)建Java Class文件的時候會報(bào)錯。
至于以${}包裹的參數(shù)設(shè)置在編輯框下方的Description中有詳細(xì)說明,在此不再贅述。
2.設(shè)置完成后,勾選下方的Enable Live Templates選項(xiàng)并Apply。

方法的注釋模板

1.選擇菜單File->Settings->Editor->LiveTemplates,點(diǎn)擊右側(cè)的+號,選擇Template Group,創(chuàng)建自己的注釋模板組。
2.選中剛剛創(chuàng)建的注釋模板組,再次點(diǎn)擊+號,選擇Live Template,在Abbreviation中設(shè)置觸發(fā)注釋提醒的快捷鍵,Description中設(shè)置描述信息,Template text中設(shè)置注釋模板,示例如下:

**
 *
 *@desc 
 $params$ 
 *@return $return$ 
 *@author wunian
 *@date $date$
 */

3.被$包裹的參數(shù)可以點(diǎn)擊右方的Edit variables進(jìn)行設(shè)置其默認(rèn)值或表達(dá)式。在本例中,我設(shè)置的參數(shù)的Expression如下:
params

#此函數(shù)返回方法中的形參以豎向排列的方式顯示,默認(rèn)顯示類似于【a,b】
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=(i==0?'*@param ':' *@param ') + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

return

#此函數(shù)返回方法的返回類型
methodReturnType()

date

#此函數(shù)返回當(dāng)前日期并格式化
date("YYYY-MM-dd")

4.在右側(cè)的Expand with中可以設(shè)置快捷鍵以迅速創(chuàng)建注釋。
5.一切都設(shè)置完畢后,Apply即可。
PS:如果你想實(shí)現(xiàn)輸入/***然后按Enter鍵就能夠迅速創(chuàng)建出注釋的效果,可以這樣做:

Abbreviation:***
Expand with:Enter
Template text:

**
 *
 *@desc 
 $params$ 
 *@return $return$ 
 *@author wunian
 *@date $date$
 */
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容