IDEA: Live Templates 方法注釋 注釋模板編寫:
打開IDEA開發工具進入設置找到Editor: File>>Setting>>Editor>>Live Templates
進入Live Templates 設置頁面:
首先創建屬於自己的模板組 >> 創建模板 按上圖步驟依次完成
開始對模板進行配置顯示的內容:
設置模板的Abbreviation 縮寫 --- 必填 >> 注釋 Description --- 可選 >> 模板內容 Template text --必填 >> 選擇模板的作用范圍 >> 快捷鍵設置。 按上圖步驟依次完成(也可步驟來)
強調:模板名稱必須為 * ,也就是Abbreviation 縮寫必須是 * 。
匹配模板內容中定義的變量進行賦值操作:
$***$是在模板內容中定義一個變量;
$END$ 是個比較特殊的變量指定了模板內容加載完成后光標顯示的位置;如果想要指定結束光標的位置則需要把每個變量的 Skip if defined 勾選上,如下圖
以上為設置 Live Templates 的步驟,這篇文章說的是創建自己的‘方法注釋模板’,圖示所顯內容也都是方法注釋方面的,下面貼出各圖中用到的代碼,附解釋:
Template text 模板內容:
/** * @Author drj * @Date $date$ * @description $END$ $param$ * @Return $return$ */
變量值賦值:
這個比較特殊需要手寫代碼實現獲取參數 $param$ 變量值: groovyScript(" def result = ''; def param = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(int i = 0;i < param.size();i++) { result += '* @Param ' + param[i] + ((i < param.size() - 1) ? '\\n' : ''); }; return result; ",methodParameters())
$date$、$return$ 的值可在Expression 欄中進行選擇對應賦值內容
復制粘貼到對應欄后直接 點擊 OK 即可
開始測試 注釋模板: 看下圖
在測試過程中發現,只有在方法內部時才會拿到 Param和Return 的值,而在方法外是拿不到的。
我們就是為了圖方便才寫的注釋模板,這樣我們每次在使用這個注釋模板的時候豈不是都要先在方法內 {* + tab}鍵后才能拿到完整的注釋內容嗎? 然后再復制到方法外,這不是又徒增了一步嗎?
為了將方便(懶)貫徹到底,又尋找嘗試了另一種寫法 發現是可以在 方法外直接 {* + tab}鍵 出現方法的完整注釋的。在使用之前我們先對模板內容進行一個小更改,就是把第一行的 / 去除即可,
然后為了保證注釋內容加載出來是完整的注釋,這時候的快捷按鍵就得調整為:{/* + tab}鍵。
看效果如圖:
注釋模板完成了!
為什么這樣才能在外部拿到值,我暫時也還不太清楚,等了解之后再寫到文章內!
有什么不解大家可以留言評論下,大家共同交流
參考鏈接:https://blog.csdn.net/qinqigang/article/details/79071486