IDEA
註釋模板設置,方法參數分行,鼠標懸停顯示方法註釋。
IDEA好用到爆炸。
1. 開啓鼠標懸停顯示方法註釋
進入idea進行設置:
(ctrl + alt + s) setting -> Editor -> General -> Show quick documentation on mouse move
2. 類、接口、枚舉、、註解, 模板註釋設置
/**
* @Author: ZhiHao
* @Date: ${DATE} ${TIME}
* @Description:
* @Versions 1.0
**/
生效後再新增的類註釋會自動添加
3. 方法模板註釋設置
IDEA依次選擇點擊:File --》 Settings --》 Editor --》 Live Templates --》點擊右側+號 --》Template Group --》輸入myTemplates --》確定
–》選中myTemplates -->點擊右側+號 --》Live Template
原封不動複製如下模板代碼
**
* $description$
* $params$
* @return $returns$
* @author: ZhiHao
* @date: $date$
*/
設置呼出快捷鍵,可以自定義,這裏先設置爲
“*”
,和Eclipse 呼出方法一樣,然後點擊 “Define”,並選中全部,也可以只選 “Java” 可以按 “Change” 更換,確定點擊OK
按照下圖設置對應的Expression,其中 params 設置需注意,請參考下面的代碼直接複製後點擊ok
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i]!= null && !''.equals(params[i])){if(i == 0){result+='\\n'}; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}}; if(result!= null && !''.equals(result)){return result}", methodParameters())
上面的groovyScript的代碼主要作用是判斷方法是否有參數,如果沒有將不輸出,有就將參數分行進行展示。
設置完畢後,先輸入
/*
在按Tab
鍵呼出註釋:
參數沒有是不會輸出註釋的。
如果覺得返回註釋格式不好看,想要不帶包名的,可以使用下面的。
先替換成下面的。
**
* $description$
* $params$ $returns$
* @author: ZhiHao
* @date: $date$
*/
然後返回值那裏替換成
groovyScript("def result=''; def params=\"${_1}\"; if(params.indexOf('<') != -1){params=params.substring(0,params.indexOf('<'));}; def list=params.split('\\\\.').toList();if(list !=null && !'void'.equalsIgnoreCase(list.get(list.size-1))){result+='\\n'+' * @return '+list.get(list.size-1);return result}", methodReturnType())
最終效果圖是這樣的, 返回值說void則沒有return註釋, 有返回值沒有包名。
在或者返回參數帶包名, 只判斷是否是void,是就不加返回註釋。複製以下代碼。
groovyScript("def result=\"${_1}\"; if(result !=null && (result.indexOf('void')== -1)){result='\\n'+' * @return '+result;return result}", methodReturnType())
效果圖