【學習記錄】IDEA編輯器 - 類、方法模板配置

lazytimes發表於2022-05-28
Idea

【學習記錄】IDEA編輯器 - 類、方法模板配置

引言

本文作為個人IDEA 編輯器類、方法模板配置操作學習記錄，方便以後升級IDEA 或者到新環境開發能快速配置。

當然IDEA 配置網上一抓一大把，個人看了很多部落格配置總是這出問題那有問題，索性自己記錄一遍免得白白浪費時間。

零、環境說明

  • 作業系統：Mac（僅代表我的環境，其實都一樣，主要看IDEA版本 ）
  • IDEA版本：任意版本的IDEA，這裡記錄的時候是 IDEA 2022.1 版本

唯一需要注意的是老版本的IDEA 可能在配置的時候有一些描述會有點不一樣，但是大部分內容應該沒有怎麼變，實在不行就給IDEA升級再弄。

一、FileHead 模板

介紹：File Header 指的是建立JAVA檔案的時候自動在頂部新增的東西。

截圖對應的配置內容：

/**
 * @Package : ${PACKAGE_NAME}
 * @Description : TODO
 * @Create on : ${DATE} ${HOUR}:${MINUTE}
 * @author 自己的姓名或者暱稱
 * @version v1.0.0
 **/

二、快速命令模板配置

介紹：命令模板就是在編寫特殊“關鍵字”的時候通過指定按鍵生成我們想要的模板。

首先來看一下配置完成效果圖，包含一個分組，一個類命令模板和方法命令模板：

方法模板

使用方式

非常簡單，只需要兩步就可以完成。

  1. 在需要新增方法註釋的程式碼上敲一個 /** 。

  1. 然後按下Tab，之後就會出現下面的效果。

實現

進入Setting頁面，先不看IDEA 的配置，我們新建一個自己的命令分組，方便自己查詢和後續管理，新建完分組之後先選中自己新建的分組，然後在新建的分組上繼續按照截圖的操作，不過這一次是往我們分組裡面新增具體的模板命令。

可以想象是自己配置父子選單的操作，相信看這篇讀者都能夠理解。

首先我們新增方法模板，Description 是給自己的命令模板加備註，Abbreviation 是觸發命令的 “關鍵詞”，注意下面截圖的頂部有一個 “Tab”的選項字樣，就是說我們寫入關鍵詞之後需要按 “Tab” 觸發。

模板內容如下：

** 
 * @description $description$ 
 * @param $params$ 
 * @return $returns$ 
 * @author $USER$
 * @date $date$ $time$
 */

注意：仔細看“關鍵字”， 模板內容前面不需要 /，具體原因可以自己加一個 / 然後嘗試一下開頭使用方式就明白了。

接著我們給自己的模板先配置 “everywhere”，意思任何地方都使用，當然怕出錯可以找到JAVA有關的檔案指定新增，自己比較懶就直接 “everywhere”了。

之後點選edit variables ，我們解決函式佔位符的格式化內容，配置生成模板之後的引數預設值。到這一步要打起精神來，因為比較容易複製出問題。

$ description $ 這樣的內容是函式佔位符，具體作用下文解釋。

對應自己要填寫的內容，參考截圖進行配置即可：

  • description：TODO

  • params：（這一塊比較容易複製出問題，而且在IDEA上貼上也只佔一行，多驗證）

    groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='' + params[i] + ((i < params.size() - 1) ? ' \\n ' + '* @param: ' : '')};return result", methodParameters())
  • returns：methodReturnType()
  • user：user()
  • date：date()
  • time：time()

一切配置完成的效果圖如下：

最後按照使用方式自己實驗一番：

/**   
* @description    
* @param xxx   
* @param: xxx   
* @param: xxx   
* @return com.xxx 
* @author xxx  
 * @date 2022/5/25 20:05  
 */

類别範本

類别範本配置比方法簡單很多，這裡就簡要說明一下。

使用方式

和“方法模板”類似，只不過是敲一個星號然後按下“Tab”。

實現

老樣子，在live template 中點選右上角的“+”號，新建一個group，新建完成之後在自定義的分組中再次新建一個命令模板，如果這些做過了就忽略這一段。

上面提供的方法模板配置如果沒有問題並且可以正常使用，這部分內容可以快速上手，這裡我就不多解釋了直接看具體操作。

Abbreviation：*（注意前面不需要/）
Des：類别範本（隨便寫）

Template 模板內容：

**
 * @description: TODO
 * @author $user$
 * @date $date$ $time$
 * @version 1.0
 */

如果沒有觸發命令，檢查是否設定"everywhere"。

點選 edit variables ，可以配置生成模板之後的引數預設值

  • user： user()
  • date： date()
  • time： time()

最後效果如下，要改寫的地方都框出來了：

最終參考效果圖如下：

最後和方法模板一樣自己找一個類驗證一下：

/**  
 * @description: TODO  
 * @author xxx  
 * @date 2022/5/25 19:50  
 * @version 1.0  
 */

以上的所有內容多操作幾遍以後就得心應手了，值得注意的部分是指令碼內容不要複製錯。

打完收工。

相關文章