IDEA Java 類注釋、方法注釋模板(可實現自動參數使用生成)


JAVA 類文件注釋設置

設置地方:

 

 

 模板

1 /**
2  * <p>
3  * $description
4  * </p>
5  * 
6  * @author Tophua
7  * @since ${DATE}
8  */

 

方法注釋:

配合模板和參數可實現0參多參的方法模板

 

新增,然后編輯寫入模板和腳本。

先增模板組,再增模板(先2后1)

 

 模板:

**
 * <p>
 * 
 * </p>
 * $param$ $return$
 * @author Tophua
 * @since $date$
 */

點擊右邊按鈕添加腳本

 

 

 按鈕點擊詳情

 

 參數(param)腳本

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


 

參數(return)腳本,兩個都可以,根據需求選擇

使用腳本可過濾void返回生成->只有有實際返回類型才回生成@return

腳本1 :返回全量方法返回類型(包括包名和泛型)

1 groovyScript("def param=\"${_1}\"; if(param == '' || param == 'void') return ''; return ' \\n * @return ' + param", methodReturnType())

 腳本2:返回簡潔方法返回類型(無包名無泛型,只有簡單的主要類型)

1 groovyScript("def param=\"${_1}\"; if(param == '' || param == 'void') return ''; param = param.replaceAll('<.*>', ''); param = param.substring(param.lastIndexOf('.') + 1); return '\\n * @return ' + param", methodReturnType())

 

添加使用范圍

鼠標右鍵選擇如圖位置或點擊下面快捷地方

 

 勾選java

 

 完成配置

 

使用:在方法上鍵入 /* + tab鍵即可生成。

 


免責聲明!

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



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