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