Intellij IDEA設置類注釋和方法注釋

背景：工欲善其事必先利其器，如果不能把工具用熟練了， 感覺很是別扭。

參考：
IntelliJ IDEA設置類注釋和方法注釋

IntelliJ IDEA 中創建類的時候，可以直接自動給類加注釋的設置，以及對方法的自動生成Java doc 注釋的示范。

注釋一共分為三種：

新建文件注釋，已有類文件注釋，方法注釋

類注釋

創建類時自動生成注釋

File》settings》editor》File and Code Templates

修改File Header.java中的內容，新建interface class enum時候就會自動帶有注釋。

ps：這里使用在class interface enum地方都配置下述注釋，這樣可以在新建的時候輸入注釋。快捷方便。

這里沒有使用@author這樣的javadoc標簽，是因為在idea中這些標簽不會顯示出來，不夠友好，為了提高閱讀性，使用下述的標簽。

/**
 * <b>Description</b>:${Description}<br>
 *
 * <b>Author</b>:lixuwu<br>
 * <b>Date</b>:${YEAR}/${MONTH}/${DAY} ${TIME}<br>
 */

通過Live Templates方式生成

Fille》Editor》Live Templates，為了方便管理，新建一個分組來管理自己添加的Live Template

這里主要是用來在類或者方法已經存在的時候添加注釋

類模板

在新建的組下面，新建Live Templates

快捷鍵：/*c+Tab  

模板內容：

**
 * <b>Description</b>: <br>
 * 
 * <b>Author</b>:lixuwu<br>
 * <b>Date</b>:$date$ $time$<br>
 */

 

 

ps：只能是上面的內容，不然的話，注釋很多bug。

關聯變量表達式

關聯文件

方法模板

快捷鍵：/**+Tab

模板內容：

*
 * @description
 * @author lixuwu
 * @date $date$ $param$
 * @return $return$
 **/

 

關聯變量：param直接復制下面的內容，然后回車即可

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result='\\n'; 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())

配置完后關聯java文件。

在方法上面輸入/**，然后按tab鍵便自動生成注釋。

 ps：這里只是記錄下配置方法，但是建議用ALT+ENTER來生成javadoc注釋，這樣比較方便。

字段注釋

建議用ALT+ENTER