想棧長我當初從 Eclipse 轉用 IDEA 真是糾結,放棄然后嘗試了N次,不過現在已經算是轉型成功了,可以完全脫離 Eclipse 擼碼了,雖然說我現在真的擼得非常少了。。
說到 IDEA 的痛點,我覺得注釋配置就不是很人性化。Eclipse 可以很方便的設置和導入公共的自定義注釋模板、格式化模板,但在 IDEA 中確實有點蹩腳,配置起來甚至有點高級,還需要用到 Grovvy 腳本。。
廢話不說了,來看下如何解決 Intellij IDEA 最頭大的問題:自定義注釋模板。。
IDEA 中有以下兩種配置模板。
- File and Code Templates
- Live Templates
下面介紹下這兩種的使用方法。
File and Code Templates
File and Code Templates 用來配置文件和代碼模板,即文件在創建的時候自動會按文件模板生成代碼注釋。
下面來演示一下如何自動生成 Java 類注釋。
依次打開下面這個菜單:
Editor > File and Code Templates > files

里面自帶了很多文件的注釋模板,只不過要自己設置,這個 class 里面的內容就是自帶的,里面有一個 #parse 的代碼。
#parse("File Header.java")
這個 File Header.java 哪里來的呢?
依次打開下面這個菜單:
Editor > File and Code Templates > files > Includes

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

從上圖也可以看到,這里的模板配置用的是 Apache Velocity 模板語言,其中的 #parse 就是 Velocity 模板語言的關鍵字。
所以,這里的 Java 類自動生成類注釋就配置完那個 File Header 就行了,配置完后,隨便創建一個類就會自動帶上注釋。
其他的文件配置方式不再撰述。
Live Templates
Live Templates 用來配置動態模板,可以在指定位置使用縮寫字母自動生成注釋。下面演示兩個創建示例,手動生成類注釋、方法注釋。
上面演示的是創建類的時候自動添加注釋,如果想手動添加類注釋,怎么加?
首先打開 Live Templates 菜單:
Editor > Live Tempaltes

上面截圖的已經配置好了 cc 和 mc,代表我輸入 cc 和 mc 后會自動帶出來類注釋、方法注釋。
右上角有個 + 號,點擊選擇 Live Template 添加一個動態模板,依次配置下面的內容。
- abbreviation: 模板縮寫
- Description: 模板描述
- Template Text: 模板內容
Template Text 里面美元符號包起來的是變量,需要點擊 Edit variable 按鈕來設置這些變量。

另外,就是設置模板使用的場景,如以下所示,點擊 Define 鏈接,設置類模板只能在 Java 語言下使用。

方法注釋和類注釋配置一致,配置示例如下:


唯一不同的是,方法里面的 params 變量需要用以下 Groovy 表達式來配置,比較麻煩。。
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())
而且方法注釋這里還有一個坑,使用 mc 時不能在方法上面,要在方法里面使用,不然 @param 帶出來的是 null, 而不是具體的參數名稱。
好了,今天就深圳了 Intellij IDEA 如何配置文件代碼模板、類和方法注釋,更多的就去研究這兩個菜單吧。
關注Java技術棧微信公眾號,棧長將繼續分享 Intellij IDEA 的實戰教程,公眾號第一時間推送,持續關注。在公眾號后台回復:idea,獲取棧長整理的更多的 Intellij IDEA 教程,都是實戰干貨,以下僅為部分預覽。
- Intellij IDEA 最常用配置詳細圖解
- Intellij IDEA 非常6的 10 個姿勢
- Intellij IDEA 所有亂碼解決方案
- Intellij IDEA 閱讀源碼的 4 個絕技
- Intellij IDEA Debug 調試技巧
- ……
如果你喜歡 IDEA, 可加入我們的知識星球《Java技術棧》,我會經常在上面分享 IDEA 的使用小技巧,對 IDEA 有什么不懂的也可以在上面向我和大家提問。
本文原創首發於微信公眾號:Java技術棧(id:javastack),關注公眾號在后台回復 "idea" 可獲取更多教程,轉載請原樣保留本信息。
