、類注釋

打開 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 方法注釋

將演示以下幾種情況：

1. 無形參
2. 單個形參
3. 多個形參
4. 無返回值
5. 有返回值

方法注釋

四、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 時，無法處理退格問題，原因同第三點。

文章作者: Jitwxs

鏈接: https://jitwxs.cn/4135e0a9.html

DEA 全稱 IntelliJ IDEA，是java編程語言開發的集成環境。IntelliJ在業界被公認為最好的java開發工具，尤其在智能代碼助手、代碼自動提示、重構、JavaEE支持、各類版本工具(git、svn等)、JUnit、CVS整合、代碼分析、 創新的GUI設計等方面的功能可以說是超常的。IDEA是JetBrains公司的產品，這家公司總部位于捷克共和國的首都布拉格，開發人員以嚴謹著稱的東歐程序員為主。它的旗艦版本還支持HTML，CSS，PHP，MySQL，Python等。免費版只支持Java,Kotlin等少數語言。

俗話說：＂工欲善其事必先利其器＂，今天準備和大家一起分享一下實際工作中能提升幸福感和工作效率的IDEA插件。

廢話不多說，let's go ！！！

1Alibaba Java Coding Guidelines

【阿里巴巴代碼規范檢查插件】

在你需要檢查的代碼上面，點擊右鍵，選擇編碼規約掃描

將會出現如下所示的檢查結果，并會給出編碼規范和提示：

2GsonFormat

【jsonToBean】

在平時的開發中，將json轉為Bean

3A8Translation

【翻譯的插件】

選中你要翻譯的漢語或英文，點擊鼠標右鍵，選擇Translate, （快捷鍵是Alt+T）就會實現翻譯，不用再去切換屏幕使用翻譯軟件翻譯了。

4Maven Helper

【分析依賴沖突的插件】

此插件可用來方便顯示maven的依賴樹，和顯示沖突，在我們梳理依賴時幫助很大。

5Free Mybatis plugin

【增強idea對mybatis支持的插件】

生成mapper xml文件 快速從代碼跳轉到mapper及從mapper返回代碼 mybatis自動補全及語法錯誤提示 集成mybatis generator gui界面 這個插件超級實用，可以從mapper接口跳轉到mybatis的xml文件中，還能找到對應地方

6Grep Console

【日志高亮顯示插件】

可以Ctrl + Alt +S Other Settings進行配色（顏色參考請搜索：電腦最護眼的色彩、顯示屏亮度亦如此）

7Lombok

當我們創建一個實體時，通常對每個字段去生成GET/SET方法，但是萬一后面需要增加或者減少字段時，又要重新的去生成GET/SET方法，非常麻煩。可以通過該插件，無需再寫那么多冗余的get/set代碼。

注意：需要在pom引入依賴

<!--lombok用來簡化實體類：需要安裝lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>

8Nyan progress bar

基于Idea使用的漂亮進度條。把你的加載進度條全都變成彩虹和貓咪

9FindBugs-IDEA

【Bug檢查插件】

在文件上或文件里面點擊鼠標右鍵，選擇FingBugs

簡單的bug能給你快速找回來，什么NPE啥的，小兒科！推薦！！（嗓門大就說一遍）

10Key Promoter X

你還在為記不住快捷鍵煩惱嗎，Key Promoter X可以幫助你快速記住常用的快捷鍵。當你在idea中用鼠標點擊菜單，它可以顯示對應的快捷鍵以及點擊次數。使用一段時間后有助于過渡到更快、無鼠標的開發。

11JavaDoc

在項目中經常要求寫代碼注釋，否則不能通過代碼門禁，JavaDoc工具可以一鍵生成注釋。

插件安裝成功后在菜單欄 code -> JavaDocs可以找到

自動生成注釋效果如下：

12ignore

項目開發中通常會使用到git進行版本管理，在提交代碼時經常有人將本地的不必要的文件提交到代碼倉庫中，使用.ignore插件可以很好解決這個問題。插件安裝完成后會在項目中生成一個.ignore文件，編輯該文件忽略一些動態生成的文件，如class文件，maven的target目錄等。

13RainbowBrackets

彩虹括號，代碼中有多個括號會顯示不同的顏色。

14Activate-power-mode

在敲代碼時有抖動酷炫的特效，非常適合給前端小姐姐表演特技。（壞笑）

15CodeGlance

16GenerateAllSetter

• 通過alt+enter對變量類生成對類的所有setter方法的調用
• 當兩個對象具有相同的字段時生成一個轉換器
• 當returnType為List Set Map時生成默認值
• 在所有getter方法上生成對assertThat的調用

17RestfulToolkit

• 根據 URL 直接跳轉到對應的方法定義 ( 快捷鍵搜索 Ctrl + Alt + N 或者 Ctrl + \ ); —這個個人感覺非常好用，和Ctrl + F一樣重要。
• 提供了一個 Services tree 的顯示窗口;
• 一個簡單的 http 請求工具;
• 在請求方法上添加了有用功能: 復制生成 URL;,復制方法參數…
• 其他功能: java 類上添加 Convert to JSON 功能，格式化 json 數據 ( Windows: Ctrl + Enter; Mac: Command + Enter )。

18JRebel

熱門部署插件，讓你在修改完代碼后，不用再重新啟動，很實用！但是，不是免費的，需要大家發揮下聰明才智自行百度破解！

19Json Parser

厭倦了打開瀏覽器格式化和驗證JSON?為什么不安裝JSON解析器并在IDE中使用離線支持呢?JSON解析器是一個用于驗證和格式化JSON字符串的輕量級插件。

20aiXcode & codota

aiXcoder是一個強大的代碼完成器和代碼搜索引擎，基于最新的深度學習技術。它有可能向您推薦一整套代碼，這將幫助您更快地編寫代碼。aiXcoder還提供了一個代碼搜索引擎，以幫助您在GitHub上搜索API用例。

類似功能的插件還有codota，codota基于數百萬個開源Java程序和您的上下文來完成代碼行，從而幫助您以更少的錯誤更快地進行編碼。新版本的codota提供以下功能：

• 全線AI自動完成
• 內聯和相關代碼示例
• 根據用戶自己的編碼實踐進行編碼建議
• 不用擔心你的代碼會被公開。codota不會將你的代碼發送到codota服務器，它只會從當前編輯的文件中發送最少的上下文信息，從而使codota能夠根據你當前的本地范圍進行預測。

比如我想知道list.stream.map(…)方法的參考使用,只需要光標定位在map上，然后右鍵選擇菜單“Get relevant examples”或者使用快捷鍵“Ctrl + Shift + O”就可以快速搜索出來很多示例，非常方便。

來源：blog.csdn.net/CSDN_SAVIOR/article/details/122505538