??在使用Idea的時候忱反,它的注釋模板很簡單,不夠詳細滤愕;所有大多數(shù)開發(fā)者都想設置一個比較詳細的注釋模板温算,我現(xiàn)在把我了解的創(chuàng)建類注釋模板和方法注釋模板的操作記錄下來,分享給大家
我們需要定義的注釋模板如下:
類注釋模板:
方法注釋模板:
一间影、設置IDEA 中的類注釋模板
File -> Settings -> Editor -> File and Code Templates -> Files
選擇Class , Interface 注竿,Enum 等等,我們都可以看到,在右側區(qū)域中巩割,在public class 上面裙顽,都有一行 #parse("File Header.java") ,
這句代碼是引入了File Header.java文件宣谈,作為我們創(chuàng)建的Class Interface ,Enum 等文件的注釋愈犹,那么這個類在哪呢,我們可以看到闻丑,在 Files 右側甘萧,有一個 Includes 選項,在這里梆掸,我們可以定義各種的模板扬卷,在需要的地方去引入這個模板,這里已經(jīng)在類文件中引入了File Header.java 模板酸钦,那我們就更改這個模板成為我們想設置成的樣子
/**
* @ClassName ${NAME}.java
* @author admin
* @version 1.0.0
* @Description TODO
* @createTime ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:00
*/
*注:
${PACKAGE_NAME} : 包路徑
${NAME} : 文件名
${USER} : 主機用戶名
${DATE} : 系統(tǒng)當前日期怪得,格式為:yyyy/mm/dd
${TIME} : 系統(tǒng)當前時間 格式為:HH:mm
${YEAR}:當前年
${MONTH}:當前月
${MONTH_NAME_SHORT} : 月份名稱簡寫;如:Jan, Feb, etc.
${MONTH_NAME_FULL} : 月份名稱全拼卑硫;如:January, February.
${DAY} :當前天
${DAY_NAME_SHORT} :星期簡寫徒恋;如:Mon, Tue, etc.
${DAY_NAME_FULL}:星期全寫;如:Mon, Tue, etc.
${HOUR} : 當前小時
${MINUTE} :當前分鐘
${PROJECT_NAME} : 項目名稱
二欢伏、定義方法注釋模板
File -> Settings -> Editor -> Live Templates
-
在Live Templates 右側點擊+號入挣,添加一個Templates Group,命名為 methodTemplates
-
在剛剛創(chuàng)建的 methodTemplates 下創(chuàng)建一個 Live Templates 硝拧,如下
- 1)径筏、在位置1處: 輸入模板的簡寫碼
在位置2處:輸入模板的描述
在位置3處: 輸入方法注釋模板樣式,可變變量要用 $變量名$ 來表示障陶,如:$param$滋恬;
若不設置成如此的變量名,位置4不可點擊抱究,模板如下:
/**
* @title $title$
* @description $description$
* @author admin $param$
* @updateTime $date$ $TIME$ $return$
* @throws $throws$
*/
點擊位置4處:可編輯定義的變量的值恢氯,如下:
變量param 為方法的參數(shù)變量,需要根據(jù)方法的參數(shù)多少進行變化鼓寺;變量 return 為返回值類型勋拟,也要根據(jù)方法的返回值進行變化,所一要自行設置該方法妈候,設置的代碼如下敢靡,復制粘貼即可:
param :
groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())
return :
groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())
-
2)、在位置3下方州丹,點擊選擇該模板應用的范圍醋安,可選Everywhere 表示任何位置都可添加該注釋
改位置首次為 define
修改時為change
-
3)杂彭、點擊options 中的 Expand with 可選擇該模板配合使用的快捷鍵,如 Tab鍵吓揪,Space 空格鍵 亲怠, Enter 回車鍵 等等;
如在這里設置的模板關鍵詞為 * 柠辞,配合使用快捷鍵為Tab鍵
則在方法中輸入 * 团秽,在按下Tab 鍵,即可按照模板生成注釋叭首。
大功告成习勤,僅供參考!