Intellij IDEA如何自定義注釋模板的實(shí)現(xiàn)方法
想棧長(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),我覺得注釋配置就不是很人性化。Eclipse 可以很方便的設(shè)置和導(dǎo)入公共的自定義注釋模板、格式化模板,但在 IDEA 中確實(shí)有點(diǎn)蹩腳,配置起來(lái)甚至有點(diǎn)高級(jí),還需要用到 Grovvy 腳本。。
廢話不說(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 類注釋。
依次打開下面這個(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)的呢?
依次打開下面這個(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 類自動(dòng)生成類注釋就配置完那個(gè) File Header 就行了,配置完后,隨便創(chuàng)建一個(gè)類就會(huì)自動(dòng)帶上注釋。
其他的文件配置方式不再撰述。
Live Templates
Live Templates 用來(lái)配置動(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)帶出來(lái)類注釋、方法注釋。
右上角有個(gè) + 號(hào),點(diǎn)擊選擇 Live Template 添加一個(gè)動(dòng)態(tài)模板,依次配置下面的內(nèi)容。
- abbreviation: 模板縮寫
- 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è)置類模板只能在 Java 語(yǔ)言下使用。
方法注釋和類注釋配置一致,配置示例如下:
唯一不同的是,方法里面的 params 變量需要用以下 Groovy 表達(dá)式來(lái)配置,比較麻煩。。
而且方法注釋這里還有一個(gè)坑,使用 mc 時(shí)不能在方法上面,要在方法里面使用,不然 @param 帶出來(lái)的是 null, 而不是具體的參數(shù)名稱。
好了,今天就深圳了 Intellij IDEA 如何配置文件代碼模板、類和方法注釋,更多的就去研究這兩個(gè)菜單吧。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
java發(fā)起http請(qǐng)求調(diào)用post與get接口的方法實(shí)例
在實(shí)際開發(fā)過(guò)程中,我們經(jīng)常需要調(diào)用對(duì)方提供的接口或測(cè)試自己寫的接口是否合適,下面這篇文章主要給大家介紹了關(guān)于java發(fā)起http請(qǐng)求調(diào)用post與get接口的相關(guān)資料,需要的朋友可以參考下2022-08-08教你如何測(cè)試Spring Data JPA的Repository
Spring Data JPA 提供了一些便捷的方式來(lái)測(cè)試這種持久層的代碼,常見的兩種測(cè)試類型是集成測(cè)試和單元測(cè)試,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-08-08從0開始教你開發(fā)一個(gè)springboot應(yīng)用
這篇文章主要為大家介紹了從0開始開發(fā)一個(gè)springboot應(yīng)用教程,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-05-05淺談Java代碼的 微信長(zhǎng)鏈轉(zhuǎn)短鏈接口使用 post 請(qǐng)求封裝Json(實(shí)例)
下面小編就為大家?guī)?lái)一篇淺談Java代碼的 微信長(zhǎng)鏈轉(zhuǎn)短鏈接口使用 post 請(qǐng)求封裝Json(實(shí)例)。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-07-07手把手教你在eclipse創(chuàng)建第一個(gè)java?web項(xiàng)目并運(yùn)行
Eclipse是用來(lái)做開發(fā)的自由集成開發(fā)環(huán)境,這也是很多java程序員會(huì)使用的開發(fā)環(huán)境,所以可以使用eclipse創(chuàng)建javaweb項(xiàng)目,下面這篇文章主要給大家介紹了關(guān)于如何在eclipse創(chuàng)建第一個(gè)java?web項(xiàng)目并運(yùn)行的相關(guān)資料,需要的朋友可以參考下2023-02-02MyBatis-Plus實(shí)現(xiàn)公共字段自動(dòng)填充功能詳解
在開發(fā)中經(jīng)常遇到多個(gè)實(shí)體類有共同的屬性字段,這些字段屬于公共字段,也就是很多表中都有這些字段,能不能對(duì)于這些公共字段在某個(gè)地方統(tǒng)一處理,來(lái)簡(jiǎn)化開發(fā)呢?MyBatis-Plus就提供了這一功能,本文就來(lái)為大家詳細(xì)講講2022-08-08