IDEA方法，類註釋配置

IDEA方法，類註釋配置

1.文件註釋模版配置

File->Settings->Editor->File And Code Templates->Includes->File Header 如圖：
模版代碼 ${Description} 配置可以在創建文件時輸入文件說明

/**
 * ${Description}     
 * @創建者:    ${USER}
 * @創建時間:  ${DATE}  ${TIME}
 * @類名:     ${NAME}
 * @包名:     ${PACKAGE_NAME}
 * @項目名：  ${PROJECT_NAME}
 */

方法註釋配置模版

1、File–>Settings–>Editor–>Live Templates

（1）新建組：命名爲userDefine



（2）新建模板：命名爲*

*因爲IDEA生成註釋的默認方式是：/*+模板名+快捷鍵（比如若設置模板名爲add快捷鍵用Tab，則生成方式爲/add+Tab），如果不採用這樣的生成方式IDEA中沒有內容的方法將不可用，例如獲取方法參數的methodParameters(）、獲取方法返回值的methodReturnType(）

（3）設置生成註釋的快捷鍵

（4）設置模板：模板內容如下
注意第一行，只有一個＊而不是/*　在設置參數名時必須用${參數名}$的方式，否則第五步中讀取不到你設置的參數名

*
 * $end$ 
// * @作者 $USER$
 * @時間  $date$ $time$
 $param$
 * @返回 $return$
 *   @throws   $throws$ 
 */ 
 

param 值

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

（5）設置模板的應用場景


點擊模板頁面最下方的警告，來設置將模板應用於那些場景，一般選擇EveryWhere–Java即可（如果曾經修改過，則顯示爲change而不是define）

（6）設置參數的獲取方式

選擇右側的Edit variables按鈕

$\color{#FF0000}{PS:第五步和第六步順序不可顛倒，否則第六步將獲取不到方法}$

選擇每個參數對應的獲取方法（在下拉選擇框中選擇即可），網上有很多教程說獲取param時使用腳本的方式，我試過使用腳本的方式不僅麻煩而且只能在方法內部使用註釋時才能獲取到參數

（7）效果圖
創建方法，在方法上面寫：/*+模板名+Enter–>/**+Enter