-
點擊 菜單欄 : File --> Settings
-
切換選項【plugins】 ,在輸入框中搜索 【spring】,找到【spring-boot】 選中就可以了。 【Spring Boot】插件依賴於 【Spring Support】,所以一並選中就好了。
- 同樣 對於yml 文件,可以 啟動插件 【YAML】。如果該方式不能解決的話,可以嘗試安裝 插件【Spring Assistant】安裝完成后重啟生效
添加依賴提示框:
setting->build Tool->maven->repositories->選中右邊框中的local的maven庫,第一行不是local,
先關閉idea,清空文件夾的內容:C:\Users\Administrator\.IntelliJIdea2018.1\system\Maven然后重新打開idea就出現第一個是local了,點擊最右邊update
在artifactid中輸入名稱后按ctrl+alt+空格 有提醒
IDEA刷新工程:右鍵工程->reload from Disk
一、類注釋
打開 IDEA 的 Settings
,點擊 Editor-->File and Code Templates
,點擊右邊 File
選項卡下面的 Class
,在其中添加圖中紅框內的內容:
/**
* @author jitwxs
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
在我提供的示例模板中,說明了作者和時間,IDEA 支持的所有的模板參數在下方的 Description
中被列出來。
保存后,當你創建一個新的類的時候就會自動添加類注釋。如果你想對接口也生效,同時配置上圖中的 Interface
項即可。
二、方法注釋
不同於目前網絡上互相復制粘貼的方法注釋教程,本文將實現以下功能:
- 根據形參數目自動生成
@param
注解 - 根據方法是否有返回值智能生成
@Return
注解
相較於類模板,為方法添加注釋模板就較為復雜,首先在 Settings
中點擊 Editor-->Live Templates
。
點擊最右邊的 +
,首先選擇 2. Template Group...
來創建一個模板分組:
在彈出的對話框中填寫分組名,我這里叫做 userDefine:
然后選中剛剛創建的模板分組 userDefine
,然后點擊 +
,選擇 1. Live Template
:
此時就會創建了一個空的模板,我們修改該模板的 Abbreviation
、Description
和 Template text
。需要注意的是,Abbreviation
必須為 *
,最后檢查下 Expand with
的值是否為 Enter 鍵。
上圖中· Template text
內容如下,請直接復制進去,需要注意首行沒有 /
,且 \*
是頂格的。
*
*
* @author jitwxs
* @date $date$ $time$$param$ $return$
*/
注意到右下角的 No applicable contexts yet
了嗎,這說明此時這個模板還沒有指定應用的語言:
點擊 Define
,在彈框中勾選Java
,表示將該模板應用於所有的 Java 類型文件。
設置 applicable contexts
還記得我們配置 Template text
時里面包含了類似於 $date$
這樣的參數,此時 IDEA 還不認識這些參數是啥玩意,下面我們對這些參數進行方法映射,讓 IDEA 能夠明白這些參數的含義。點擊 Edit variables
按鈕:
為每一個參數設置相對應的 Expression
設置 Expression
需要注意的是,date
和 time
的 Expression
使用的是 IDEA 內置的函數,直接使用下拉框選擇就可以了,而 param
這個參數 IDEA 默認的實現很差,因此我們需要手動實現,代碼如下:
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
另外 return
這個參數我也自己實現了下,代碼如下:
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
注:你還注意到我並沒有勾選了
Skip if defined
屬性,它的意思是如果在生成注釋時候如果這一項被定義了,那么鼠標光標就會直接跳過它。我並不需要這個功能,因此有被勾選該屬性。
點擊 OK 保存設置,大功告成!
三、檢驗成果
3.1 類注釋
類注釋只有在新建類時才會自動生成
3.2 方法注釋
將演示以下幾種情況:
- 無形參
- 單個形參
- 多個形參
- 無返回值
- 有返回值
四、Q & A
(1)為什么模板的 Abbreviation
一定要叫 \*
?Expand with
要保證是 Enter 鍵?
答:因為 IDEA 模板的生成邏輯是 模板名 + 生成鍵
,當生成鍵是 Enter 時,我們輸入 * + Enter
就能夠觸發模板。
這也同時說明了為什么注釋模板首行是一個 *
了,因為當我們先輸入 /*
,然后輸入 * + Enter
,觸發模板,首行正好拼成了 /**
,符合 Javadoc 的規范。
(2)注釋模板中為什么有一行空的 \*
?
答:因為我習慣在這一行寫方法說明,所以就預留了一行空的寫,你也可以把它刪掉。
(3)注釋模板中 $time$$param$
這兩個明明不相干的東西為什么緊貼在一起?
答:首先網上提供的大部分 param 生成函數在無參情況下仍然會生成一行空的 @param
,因此我對param 函數的代碼進行修改,使得在無參情況下不生成 @param
,但是這就要求 $param$
要和別人處在同一行中,不然沒法處理退格。
(4)為什么 return 參數不使用 methodReturnType()
, 而要自己實現?
答:methodReturnType()
在無返回值的情況下會返回 void,這並沒有什么意義,因此我對 methodReturnType() 返回值進行了處理,僅在有返回值時才生成。
(5)為什么 $return$
不是單獨一行?
答:因為當 methodReturnType()
返回 null 時,無法處理退格問題,原因同第三點。