intellij idea:設置java方法注釋模板(intellij idea 2019.2)

一，打開方法注釋模板的編輯窗口

菜單file->打開settings

editor欄目下->打開Live Templates

 

說明：劉宏締的架構森林是一個專注架構的博客，地址：https://www.cnblogs.com/architectforest

         對應的源碼可以訪問這里獲取： https://github.com/liuhongdi/

說明：作者:劉宏締 郵箱: [e-mail]

 

二，創建一個模板group

在這個窗口右上角：點 + 號

選 template group

 

在enter the new group name一欄，

輸入: lhdgroup

點ok

參考下圖:

 

 

三，創建注釋模板

選中創建的lhdgroup,

再次點擊+號，選擇: live template

1,設置縮寫:

abbreviation:輸入: *

為什么用*:  

這樣在實際開發中，

可以在輸入 /*后點tab,直接生成注釋

 

2,設置模板的內容:

template text一欄輸入:

*
*@author:$user$
*@date:$date$ $time$
*@description:
$params$
*@return:
*/

說明：注意開始處沒有/,

因為習慣上我們已經手動輸入/*了

如圖:

 

3,選擇應用的環境:

應用上下文:點 define

然后選中 java

 

4,編輯變量:

點edit variables:

 

user:  default value: 輸入:liuhongdi

date: expression輸入: date()

time:expression輸入: time()

params: default value: 輸入:

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())

如圖:

四，最后點擊 apply和ok保存

 

五,  應用我們創建的注釋模板:

輸入/*后點 tab鍵，會自動生成注釋，例:

@RestController
@RequestMapping("/user")
public class UserController {
    /*
    *@author:liuhongdi
    *@date:2020/7/1 下午2:44
    *@description:
     * @param username
     * @param passward
    *@return:
    */
    @PostMapping(value = "/login")
    public ResultUtil login(String username, String passward) {
        return ResultUtil.success(null);
    }
}

然后編輯注釋的內容即可