在使用IDEA過程中,很多人可能感覺自帶注釋太簡約了,想增加一些屬性,比如作者、創建時間、版本號等等,這個時候我們可以使用自定義的注釋模板來實現我們需求,話不多說直接進入如何自定義模板設置:
打開設置界面:
File --> Settings
創建模板組:
Editor --> Live Templates --> 點擊“+” --> 2.Template Group --> 輸入名稱,點擊OK(我輸入的是My Group)
創建模板:
選中新建的模板組(My Group) --> 點擊“+” --> 1.Live Template
模板設置:
1.設置模板前綴,如果設置為,使用時 /* + Enter鍵(第5步設置該按鍵),如果設置為a,使用時 /*a + Enter鍵,其他類推
2.設置該模板應用范圍,mothed表示方法,file表示類上面
3.填寫模板內容,具體內容會在后面補充,可以參考
4.設置模板中變量的取值
5.設置執行按鍵,默認是Tab,我一般習慣改為Enter鍵。該功能主要配合步驟1中的模板前綴使用
6.設置模板應用范圍,一般是點擊第一個進行全選操作。
模板樣例及取值設置
1.方法的注釋模板:其中的author可以更改,其他一般默認即可
/*
* 。
*
$params$
* @return $returns$
* @exception $exception$
* @author silenter
* @date $date$ $time$
*/
2.模板的變量取值設置
params: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) ? '\\r\\n' : '')}; return result", methodParameters())
returns:methodReturnType()
exception:expressionType(Expression)
date:date()
time:time()