IDEA配置注釋模板


直接進入主題:

Ctrl+Alt+S進入設置界面(我沒改過按鍵映射,你也可以從File-OtherSetting進入設置),找到Editor->File and Code Templates,先在Includes里面加個名為File Header的文件頭描述,如下圖操作:

 
 

然后點擊左邊的files配置應用到哪些類型的文件,我們選擇Class,然后右邊輸入注釋模板內容如下並保存:

#parse("File Header.java")

#if (${PACKAGE_NAME} &&${PACKAGE_NAME} !="")package${PACKAGE_NAME};#end

/**

*@ClassName${NAME}

*@Description

*@Author

*@Date${DATE} ${TIME}

*@Version V1.0

**/

public class${NAME} {

}

java類的文件頭就配置好了,接下來配置函數方法的注釋:

 
 

先按照上圖添加一個名為x-templates的群組(取你心儀的名字也ok),選中這個組,再次點右邊的加號添加具體的模板如下圖:

 
 

模板內容如下:

 

* 功能描述:

$params$

* @return: $return$

* @Author: $user$

* @Date: $date$ $time$

*/

注意最開始那里有一個空行的,並且參數這一行沒有前面的*@Param 前綴,還往前頂了2個空格的位置(有強迫症,最后的結果不完美睡不着)。然后設置快捷鍵為+號,並且修改params這個參數變量:

 

 
 

名為params的這個參數,Expression這一列留空,在右邊的Default value里面輸入以下內容(不這么做,得到的入參就是一個數組,不會每個入參換一行的):

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())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())

 

好了,保存(我的快捷鍵是配置為加號+Enter),實際用的時候如果只是輸入加號+Enter的話,得不到一些參數值的,具體不知道IDEA什么bug,我是這么用就完美解決了:

輸入/**后再輸入我的快捷鍵:加號+Enter,完美有木有?

 


免責聲明!

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



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