IDEA 設置類和方法注釋模板

• 2020 年 3 月 8 日
• 筆記

設置類模板

位置

File -> Settings -> Editor -> File and Code Templates

選擇 Includes

創建文件頭

點擊 「+」，改名為 File Header，內容如下

/**   * @Description: ${DESCRIPTION}   *   * @Author ${USER}   * @Date ${DATE} ${TIME}   * @Version 1.0   */

設置方法註解模板

位置

File -> Settings -> Editor -> Live Templates

創建組

點擊 「+」，Create New Group，輸入【自定義組名，例如 userDefine】

創建模板

點擊 「+」，Live Template

配置模板

Abbreviation：設置模板名稱，建議就是 * 號

Description：模板描述，可選

Template text：模板，注意開頭是沒有 /* 的

*   * @Description: $END$   * @Author: $user$   * @Date: $date$ $time$   $param$   $return$   **/

設置模板的應用場景

點擊模板頁面最下方的警告，來設置將模板應用於那些場景，一般選擇 EveryWhere -> Java 即可

設置參數的獲取方式

點擊 Edit variables

Skip if defined

建議打勾，不然每次創建，都會先跳到上面每個參數，優先修改此參數

param Default value

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

return Default value

groovyScript("def returnType = "${_1}"; def result = '* @return: ' + returnType; return result;", methodReturnType());