IDEA自定義類註釋和方法註釋（自定義groovyScript方法實現多行引數註釋）

愛咖啡的尼爾發表於2020-06-20
Idea

一、類註釋

1、開啟設定皮膚：file -> setting -> Editor -> file and code Templates

選擇其中的inclues選項卡，並選擇File header，如圖。不要選擇Files選項卡再設定Class，這樣比較麻煩，而且這樣設定以後沒新建一個類都要自己寫一次Date。

2、在右邊編輯皮膚插入自己想要的註釋即可。其中${}是變數，需要在變數基本都在編輯款下面的Description，往下拉即可看到。
/*
* @Classname ${NAME}
*
* @Date ${DATE}
*
* @userName
*/
3、新建一個類，看是否自動加了註釋

 

二、方法註釋

1、開啟設定皮膚：file -> setting -> Editor -> Live Templates

 

 2、新建一個Template Group…，命名隨意，假設為bokeyuan，然後選擇該組，點選新建一個模板Live Template

 

3、名稱建議設為*，文字框輸入自己想要設定的註釋格式，右下角要選擇enter（原本是tab）。

 

 4、留意註釋格式，其中引數要直接寫變數$param$，開頭只有一個*號。寫好之後點選上圖框中的edit variables

 

其中返回值return使用系統自帶的，下拉可以找到methodReturnType()

 

 

 5、自定義多行引數註釋

IDEA自帶的引數函式methodParameters()產出的註釋格式是這樣的：

/**
      * 
      * @param [a,b,c]
      * @return void
      * @throws 
      */

我們可能需要的是多行引數註釋：

/**
      * 
      * @param a
      * @param b
      * @param c
      * @return void
      * @throws 
      */

這個時候就要使用裡面的groovyScript()函式來自定義格式：

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

直接複製在Expression裡面即可。

 

6、選擇語言，點選Define勾選Java

 

 

有其他問題可以評論問我哦

相關文章