天天看點

Intellij IDEA 撸碼最頭大的問題。。

Intellij IDEA 撸碼最頭大的問題。。

想棧長我當初從 Eclipse 轉用 IDEA 真是糾結,放棄然後嘗試了N次,不過現在已經算是轉型成功了,可以完全脫離 Eclipse 撸碼了,雖然說我現在真的撸得非常少了。。

說到 IDEA 的痛點,我覺得注釋配置就不是很人性化。Eclipse 可以很友善的設定和導入公共的自定義注釋模闆、格式化模闆,但在 IDEA 中确實有點蹩腳,有點頭大,配置起來甚至有點進階,還需要用到 Grovvy 腳本。。

廢話不說了,來看下如何解決 Intellij IDEA 最頭大的問題:自定義注釋模闆。。

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

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

File and Code Templates

File and Code Templates 用來配置檔案和代碼模闆,即檔案在建立的時候自動會按檔案模闆生成代碼注釋。

下面來示範一下如何自動生成 Java 類注釋。

依次打開下面這個菜單:

Editor > File and Code Templates > files

Intellij IDEA 撸碼最頭大的問題。。

裡面自帶了很多檔案的注釋模闆,隻不過要自己設定,這個 class 裡面的内容就是自帶的,裡面有一個 #parse 的代碼。

#parse("File Header.java")      

這個 File Header.java 哪裡來的呢?

Editor > File and Code Templates > files > Includes

Intellij IDEA 撸碼最頭大的問題。。

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

Intellij IDEA 撸碼最頭大的問題。。

從上圖也可以看到,這裡的模闆配置用的是 Apache Velocity 模闆語言,其中的 #parse 就是 Velocity 模闆語言的關鍵字。

是以,這裡的 Java 類自動生成類注釋就配置完那個 File Header 就行了,配置完後,随便建立一個類就會自動帶上注釋。

其他的檔案配置方式不再撰述。

Live Templates

Live Templates 用來配置動态模闆,可以在指定位置使用縮寫字母自動生成注釋。下面示範兩個建立示例,手動生成類注釋、方法注釋。

上面示範的是建立類的時候自動添加注釋,如果想手動添加類注釋,怎麼加?

首先打開 Live Templates 菜單:

Editor > Live Tempaltes

Intellij IDEA 撸碼最頭大的問題。。

上面截圖的已經配置好了 cc 和 mc,代表我輸入 cc 和 mc 後會自動帶出來類注釋、方法注釋。

右上角有個 + 号,點選選擇 Live Template 添加一個動态模闆,依次配置下面的内容。

Template Text 裡面美元符号包起來的是變量,需要點選 Edit variable 按鈕來設定這些變量。

Intellij IDEA 撸碼最頭大的問題。。

另外,就是設定模闆使用的場景,如以下所示,點選 Define 連結,設定類模闆隻能在 Java 語言下使用。

Intellij IDEA 撸碼最頭大的問題。。

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

Intellij IDEA 撸碼最頭大的問題。。

唯一不同的是,方法裡面的 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 如何配置檔案代碼模闆、類和方法注釋,更多的就去研究這兩個菜單吧。

繼續閱讀