IDEA 創(chuàng)建類注釋模板和方法注釋模板

??在使用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

  1. 在Live Templates 右側點擊+號入挣,添加一個Templates Group,命名為 methodTemplates


    添加一個Templates Group
methodTemplates
  1. 在剛剛創(chuàng)建的 methodTemplates 下創(chuàng)建一個 Live Templates 硝拧,如下


    image.png
  • 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 表示任何位置都可添加該注釋


    image.png

改位置首次為 define


image.png

修改時為change


image.png
  • 3)杂彭、點擊options 中的 Expand with 可選擇該模板配合使用的快捷鍵,如 Tab鍵吓揪,Space 空格鍵 亲怠, Enter 回車鍵 等等;


    image.png

如在這里設置的模板關鍵詞為 * 柠辞,配合使用快捷鍵為Tab鍵
則在方法中輸入 * 团秽,在按下Tab 鍵,即可按照模板生成注釋叭首。


生成注釋

大功告成习勤,僅供參考!

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末焙格,一起剝皮案震驚了整個濱河市图毕,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌眷唉,老刑警劉巖予颤,帶你破解...
    沈念sama閱讀 216,692評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異冬阳,居然都是意外死亡蛤虐,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評論 3 392
  • 文/潘曉璐 我一進店門肝陪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來驳庭,“玉大人,你說我怎么就攤上這事氯窍∷浅#” “怎么了?”我有些...
    開封第一講書人閱讀 162,995評論 0 353
  • 文/不壞的土叔 我叫張陵荞驴,是天一觀的道長不皆。 經(jīng)常有香客問我,道長熊楼,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,223評論 1 292
  • 正文 為了忘掉前任能犯,我火速辦了婚禮鲫骗,結果婚禮上,老公的妹妹穿的比我還像新娘踩晶。我一直安慰自己执泰,他們只是感情好,可當我...
    茶點故事閱讀 67,245評論 6 388
  • 文/花漫 我一把揭開白布渡蜻。 她就那樣靜靜地躺著术吝,像睡著了一般计济。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上排苍,一...
    開封第一講書人閱讀 51,208評論 1 299
  • 那天,我揣著相機與錄音传藏,去河邊找鬼。 笑死毯侦,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的具垫。 我是一名探鬼主播侈离,決...
    沈念sama閱讀 40,091評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼筝蚕,長吁一口氣:“原來是場噩夢啊……” “哼霍狰!你這毒婦竟也來了饰及?” 一聲冷哼從身側響起蔗坯,我...
    開封第一講書人閱讀 38,929評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎燎含,沒想到半個月后宾濒,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體屏箍,經(jīng)...
    沈念sama閱讀 45,346評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,570評論 2 333
  • 正文 我和宋清朗相戀三年卸奉,在試婚紗的時候發(fā)現(xiàn)自己被綠了颖御。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,739評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡潘拱,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出芦岂,到底是詐尸還是另有隱情,我是刑警寧澤腺怯,帶...
    沈念sama閱讀 35,437評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站呛占,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏决左。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,037評論 3 326
  • 文/蒙蒙 一佛猛、第九天 我趴在偏房一處隱蔽的房頂上張望坠狡。 院中可真熱鬧,春花似錦逃沿、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽假消。三九已至,卻和暖如春臼予,著一層夾襖步出監(jiān)牢的瞬間啃沪,已是汗流浹背粘拾。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評論 1 269
  • 我被黑心中介騙來泰國打工缰雇, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留签餐,地道東北人寓涨。 一個月前我還...
    沈念sama閱讀 47,760評論 2 369
  • 正文 我出身青樓,卻偏偏與公主長得像体捏,于是被迫代替她去往敵國和親糯崎。 傳聞我的和親對象是個殘疾皇子河泳,可洞房花燭夜當晚...
    茶點故事閱讀 44,647評論 2 354

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

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn)薄霜,斷路器纸兔,智...
    卡卡羅2017閱讀 134,652評論 18 139
  • 官網(wǎng) 中文版本 好的網(wǎng)站 Content-type: text/htmlBASH Section: User ...
    不排版閱讀 4,380評論 0 5
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong閱讀 22,394評論 1 92
  • 清晨的街崎坊,淡然消色洲拇; 事散逐香塵流水,無言草自春。 正午的街芹彬,喧鬧繁華; 恬談如行云流水,無情樹更盛。 黃昏的街,...
    Santa夜雨閱讀 401評論 2 6