這篇文章主要介紹了Intellij IDEA自定義注釋模板怎么弄,具有一定借鑒價(jià)值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
創(chuàng)新互聯(lián)公司是一家集網(wǎng)站建設(shè),寶應(yīng)企業(yè)網(wǎng)站建設(shè),寶應(yīng)品牌網(wǎng)站建設(shè),網(wǎng)站定制,寶應(yīng)網(wǎng)站建設(shè)報(bào)價(jià),網(wǎng)絡(luò)營銷,網(wǎng)絡(luò)優(yōu)化,寶應(yīng)網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè),幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競爭力??沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時(shí)我們時(shí)刻保持專業(yè)、時(shí)尚、前沿,時(shí)刻以成就客戶成長自我,堅(jiān)持不斷學(xué)習(xí)、思考、沉淀、凈化自己,讓我們?yōu)楦嗟钠髽I(yè)打造出實(shí)用型網(wǎng)站。
想棧長我當(dāng)初從 Eclipse 轉(zhuǎn)用 IDEA 真是糾結(jié),放棄然后嘗試了N次,不過現(xiàn)在已經(jīng)算是轉(zhuǎn)型成功了,可以完全脫離 Eclipse 擼碼了,雖然說我現(xiàn)在真的擼得非常少了。。
說到 IDEA 的痛點(diǎn),我覺得注釋配置就不是很人性化。Eclipse 可以很方便的設(shè)置和導(dǎo)入公共的自定義注釋模板、格式化模板,但在 IDEA 中確實(shí)有點(diǎn)蹩腳,配置起來甚至有點(diǎn)高級(jí),還需要用到 Grovvy 腳本。。
廢話不說了,來看下如何解決 Intellij IDEA 最頭大的問題:自定義注釋模板。。
IDEA 中有以下兩種配置模板。
File and Code Templates
Live Templates
下面介紹下這兩種的使用方法。
File and Code Templates
File and Code Templates 用來配置文件和代碼模板,即文件在創(chuàng)建的時(shí)候自動(dòng)會(huì)按文件模板生成代碼注釋。
下面來演示一下如何自動(dòng)生成 Java 類注釋。
依次打開下面這個(gè)菜單:
Editor > File and Code Templates > files
里面自帶了很多文件的注釋模板,只不過要自己設(shè)置,這個(gè) class 里面的內(nèi)容就是自帶的,里面有一個(gè) #parse
的代碼。
#parse("File Header.java")
這個(gè) File Header.java 哪里來的呢?
依次打開下面這個(gè)菜單:
Editor > File and Code Templates > files > Includes
其實(shí)這個(gè) Includes 就是前面 Files 模板里面 parse 引用的片段而已。File Header 這里默認(rèn)是空的,然后在這個(gè)片段里面編輯模板即可,支持一些預(yù)定義的變量,如:DATE、TIME、USER 等,上圖給的是配置示例。
從上圖也可以看到,這里的模板配置用的是 Apache Velocity 模板語言,其中的 #parse 就是 Velocity 模板語言的關(guān)鍵字。
所以,這里的 Java 類自動(dòng)生成類注釋就配置完那個(gè) File Header 就行了,配置完后,隨便創(chuàng)建一個(gè)類就會(huì)自動(dòng)帶上注釋。
其他的文件配置方式不再撰述。
Live Templates
Live Templates 用來配置動(dòng)態(tài)模板,可以在指定位置使用縮寫字母自動(dòng)生成注釋。下面演示兩個(gè)創(chuàng)建示例,手動(dòng)生成類注釋、方法注釋。
上面演示的是創(chuàng)建類的時(shí)候自動(dòng)添加注釋,如果想手動(dòng)添加類注釋,怎么加?
首先打開 Live Templates 菜單:
Editor > Live Tempaltes
上面截圖的已經(jīng)配置好了 cc 和 mc,代表我輸入 cc 和 mc 后會(huì)自動(dòng)帶出來類注釋、方法注釋。
右上角有個(gè) + 號(hào),點(diǎn)擊選擇 Live Template 添加一個(gè)動(dòng)態(tài)模板,依次配置下面的內(nèi)容。
abbreviation: 模板縮寫
Description: 模板描述
Template Text: 模板內(nèi)容
Template Text 里面美元符號(hào)包起來的是變量,需要點(diǎn)擊 Edit variable
按鈕來設(shè)置這些變量。
另外,就是設(shè)置模板使用的場景,如以下所示,點(diǎn)擊 Define 鏈接,設(shè)置類模板只能在 Java 語言下使用。
方法注釋和類注釋配置一致,配置示例如下:
唯一不同的是,方法里面的 params 變量需要用以下 Groovy 表達(dá)式來配置,比較麻煩。。
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())
而且方法注釋這里還有一個(gè)坑,使用 mc 時(shí)不能在方法上面,要在方法里面使用,不然 @param 帶出來的是 null, 而不是具體的參數(shù)名稱。
好了,今天就深圳了 Intellij IDEA 如何配置文件代碼模板、類和方法注釋,更多的就去研究這兩個(gè)菜單吧。
感謝你能夠認(rèn)真閱讀完這篇文章,希望小編分享的“Intellij IDEA自定義注釋模板怎么弄”這篇文章對大家有幫助,同時(shí)也希望大家多多支持創(chuàng)新互聯(lián),關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,更多相關(guān)知識(shí)等著你來學(xué)習(xí)!