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

相關推薦