IDEA設置注釋模板最佳實踐


效果

在方法上輸入/**,然后按tab鍵,生成的效果如下
1536055768001.jpg

配置步驟

1. 在Live Templates中添加模板組,命名隨意,主要是為了存放自定義的模板,方便管理

tapd_20988451_base64_1536053182_18.png

2. 在模板組下添加一個模板,具體配置如下

1. Abbreviation 填寫 *

(注:曾經我填寫的是/** ,發現攔截/**會導致某些情況下無法獲取對應參數的)
1536054663460.jpg

2. Template text 填寫

* 
 * 
 * 
 $param$
 * @author XxxYyyZzz
 * @date $date$   
*/ 

3. 點擊Edit variables,date字段選擇date(),param中填寫以下內容

groovyScript("def result=''; 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()) 

1536054939594.jpg

4. 在Expand with中選擇tab,然后點擊Apply即可

(也可選擇其他按鍵,表示觸發的按鍵,個人比較喜歡用tab,避免與原有按鍵沖突)
1536055074276.jpg


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM