Intellij IDEA 最頭大的問題，如何自定義註釋模板？

想棧長我當初從 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" 可獲取更多教程，轉載請原樣保留本信息。