idea配置代碼注釋模板

從eclipse換成idea后，有點不習慣，其中之一就是代碼注釋，感覺不如eclipse好用，下面是一些配置方法，配完之后差不多能實現eclipse的效果。

1、以配置Class的注釋為例，其他文件的類似，打開File - settings之后，找到下圖的位置，選中Class后修改備注，變量和參數跟eclipse差不多就不多講了。配置完這里后再新建class就會應用新的注釋模板了，但是我也只能發現新建的時候應用，如果已有方法還是不會自動引用，只能手動維護。

 

 

 

 

 

可以隨意定義自己的備注格式，這里只做演示

/**
 * TODO
 * @version 1.0
 * @author ${USER}
 * @date ${DATE} ${TIME}
 */

 

2、配置方法的注釋，這個就比上面復雜一些了。先按照下圖創建組，名稱隨便輸。

 

 

 

然后在新建的組里創建模板，參數按照截圖中的輸入，Reformat那個復選框是為了避免換行后出現縮進的問題

 

 

 

 

 

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

注意上面的一個星號不是寫錯了，必須這么寫，變量用$$包起來，下面還會設置變量。格式還是自己隨便定，此處只是例子

 

設置變量，點擊頁面上的Edit variables按鈕，然后將上面$$中的變量跟idea的內置參數關聯起來，其中params內置的變量的沒有很合適的，在下面寫了個腳本，可以直接復制

 

 

 

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

點確定保存之后，在代碼上面輸入 /** 后按回車，可以自動引用配置的模板，如下圖的效果，我找了找沒找到像eclipse類似的快捷鍵，只能這么輸入

 

 

我是剛剛換成idea，很多功能也不太會用，針對注釋模板暫時就發現了這么多，如果誰有更好的方法，歡迎跟我說說