Intellij IDEA如何自定義注釋模板的實(shí)現(xiàn)方法

更新時(shí)間：2019年05月15日 10:43:16 作者：Java技術(shù)棧

這篇文章主要介紹了Intellij IDEA如何自定義注釋模板的實(shí)現(xiàn)方法，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

想棧長(zhǎng)我當(dāng)初從 Eclipse 轉(zhuǎn)用 IDEA 真是糾結(jié)，放棄然后嘗試了N次，不過(guò)現(xiàn)在已經(jīng)算是轉(zhuǎn)型成功了，可以完全脫離 Eclipse 擼碼了，雖然說(shuō)我現(xiàn)在真的擼得非常少了。。

說(shuō)到 IDEA 的痛點(diǎn)，我覺(jué)得注釋配置就不是很人性化。Eclipse 可以很方便的設(shè)置和導(dǎo)入公共的自定義注釋模板、格式化模板，但在 IDEA 中確實(shí)有點(diǎn)蹩腳，配置起來(lái)甚至有點(diǎn)高級(jí)，還需要用到 Grovvy 腳本。。

廢話(huà)不說(shuō)了，來(lái)看下如何解決 Intellij IDEA 最頭大的問(wèn)題：自定義注釋模板。。

IDEA 中有以下兩種配置模板。

File and Code Templates
Live Templates

下面介紹下這兩種的使用方法。

File and Code Templates

File and Code Templates 用來(lái)配置文件和代碼模板，即文件在創(chuàng)建的時(shí)候自動(dòng)會(huì)按文件模板生成代碼注釋。

下面來(lái)演示一下如何自動(dòng)生成 Java 類(lèi)注釋。

依次打開(kāi)下面這個(gè)菜單：

Editor > File and Code Templates > files

里面自帶了很多文件的注釋模板，只不過(guò)要自己設(shè)置，這個(gè) class 里面的內(nèi)容就是自帶的，里面有一個(gè) #parse 的代碼。

#parse("File Header.java")

這個(gè) File Header.java 哪里來(lái)的呢？

依次打開(kāi)下面這個(gè)菜單：

Editor > File and Code Templates > files > Includes

其實(shí)這個(gè) Includes 就是前面 Files 模板里面 parse 引用的片段而已。File Header 這里默認(rèn)是空的，然后在這個(gè)片段里面編輯模板即可，支持一些預(yù)定義的變量，如：DATE、TIME、USER 等，上圖給的是配置示例。

從上圖也可以看到，這里的模板配置用的是 Apache Velocity 模板語(yǔ)言，其中的 #parse 就是 Velocity 模板語(yǔ)言的關(guān)鍵字。

所以，這里的 Java 類(lèi)自動(dòng)生成類(lèi)注釋就配置完那個(gè) File Header 就行了，配置完后，隨便創(chuàng)建一個(gè)類(lèi)就會(huì)自動(dòng)帶上注釋。

其他的文件配置方式不再撰述。

Live Templates

Live Templates 用來(lái)配置動(dòng)態(tài)模板，可以在指定位置使用縮寫(xiě)字母自動(dòng)生成注釋。下面演示兩個(gè)創(chuàng)建示例，手動(dòng)生成類(lèi)注釋、方法注釋。

上面演示的是創(chuàng)建類(lèi)的時(shí)候自動(dòng)添加注釋?zhuān)绻胧謩?dòng)添加類(lèi)注釋?zhuān)趺醇樱?/p>

首先打開(kāi) Live Templates 菜單：

Editor > Live Tempaltes

上面截圖的已經(jīng)配置好了 cc 和 mc，代表我輸入 cc 和 mc 后會(huì)自動(dòng)帶出來(lái)類(lèi)注釋、方法注釋。

右上角有個(gè) + 號(hào)，點(diǎn)擊選擇 Live Template 添加一個(gè)動(dòng)態(tài)模板，依次配置下面的內(nèi)容。

abbreviation：模板縮寫(xiě)
Description：模板描述
Template Text：模板內(nèi)容

Template Text 里面美元符號(hào)包起來(lái)的是變量，需要點(diǎn)擊 Edit variable 按鈕來(lái)設(shè)置這些變量。

另外，就是設(shè)置模板使用的場(chǎng)景，如以下所示，點(diǎn)擊 Define 鏈接，設(shè)置類(lèi)模板只能在 Java 語(yǔ)言下使用。

方法注釋和類(lèi)注釋配置一致，配置示例如下：

唯一不同的是，方法里面的 params 變量需要用以下 Groovy 表達(dá)式來(lái)配置，比較麻煩。。

復(fù)制代碼代碼如下:

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 帶出來(lái)的是 null, 而不是具體的參數(shù)名稱(chēng)。

好了，今天就深圳了 Intellij IDEA 如何配置文件代碼模板、類(lèi)和方法注釋?zhuān)嗟木腿パ芯窟@兩個(gè)菜單吧。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: