idea註釋模版配置
idea作爲越來越多程序員使用的開發工具,平時的代碼註釋也非常的關鍵,下面介紹一下類上註釋和方法上註釋,方便大家的開發配置,同時也爲自己以後配置留一份記錄(畢竟每次換環境都需要重新配置一遍)
1、新建類的時候自動添加類註釋
1)按照上圖的提示,找到位置1的File and Code Templates
(2)選擇右側的Files選項卡,選擇位置2的Class(如果需要設置接口和枚舉的註釋模版,只需要選擇Interface和Enum,按照步驟3配置一下就ok了)
(3)在最右側的輸入欄中,輸入位置3框住的一段註釋代碼,然後點擊保存即可
/**
* @description: TODO
* @author ${USER}
* @date ${DATE} ${TIME}
* @version 1.0
*/
來看一下效果圖吧:
2、自定義模版配置(類,方法)
通過第2點的By default expand with enter 和下面Abbreviation中的*,**號,即輸入/*,然後點擊enter回車鍵調出方法註釋模板,/**和enter按鍵調出類註釋模板,注意
輸入模板內容Template Text的時候,前面不能加“/”
1)按照上圖的提示,找到位置1的Live Templates
(2)找到位置2,選擇下拉框中的Enter選項
(3)到位置3點擊“+”號,首先選擇Template Group,新建一個自己的分組
(4)鼠標選中新建的分組,如位置4的ybyGroup,然後在點擊位置3的“+”號,選擇Live Template
(5)給模版添加快捷提示的字符,描述,和模版,比如我這裏新增了兩個,方法的註釋*,類註釋**
(6)在位置5處的Template text裏面貼上模版內容
(7)在位置6選擇應用的範圍,一般選擇EveryWhere裏面的Java就可以了
(8)在位置7配置Template Text裏面用$修飾的屬性,具體配置截圖如下:
user的default value:
user()
date的default value:
date()
time的default value:
time()
params的default value:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='' + params[i] + ((i < params.size() - 1) ? ' \\n ' + '* @param: ' : '')};return result", methodParameters())
方法註釋模版:
**
* @description: $description$
* @param: $params$
* @return: $returns$
* @author $USER$
* @date: $date$ $time$
*/
類註釋模版:
**
* @description: TODO
* @author $user$
* @date $date$ $time$
* @version 1.0
*/