IDEA設置模板註釋
設置類文件模板註釋
類文件包含class、interface、enum、@interface
首先是點擊File,在下拉列表中選擇Setting選項
在彈出窗口選擇Editor選項下的File and Code Template選項,在右側選擇includes選項卡下的File Header選項
想要知道我們編寫類文件模板註釋可以使用哪些變量可以參考當前窗口右側下方Description中提供的變量
在此窗口提供的模板註釋地方填入如下信息
/**
* 文件描述
*
* @author hongwei.lian
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
點擊Apply,最後點擊OK即可
嘗試新建一個Java Class文件
輸入類名,點擊OK即可
生成的Java Class文件描述如下:
設置方式模板註釋
專指method
首先是點擊File,在下拉列表中選擇Setting選項
在彈出窗口選擇Editor選項下的Live Template選項,在右側點擊綠色的+號,在出現的兩個下拉列表選項中選擇Template Group
輸入Template Group名字,點擊OK
選中剛纔新建的Template Group,點擊右側的+號,在出現的兩個下拉列表選項中選擇Live Template
輸入快捷鍵名稱,點擊最下方的Define,在列表中選擇Java
在提供的空白處輸入以下內容:
* 方法描述
*
$params$
* @author hongwei.lian
* @date $date$ $time$
*/
因爲編輯的部分存在三個變量,也就是$$包裹的變量名稱,這時候後側的Edit variables纔可以編輯,點擊編輯
按照如下編寫:
說明:
1、對於params做特殊處理,表達式部分空着不填,默認值部分則寫入如下一段groovy語言編寫的代碼,groovy語言是兼容Java語言的,很好理解下面這段代碼,
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())
爲何要做特殊處理呢,因爲IDRA提供的變量
呈現出的是一個數組形式的參數列表,
而我們需要的形式
以上做法便是提供出這樣的模板註釋
2、對於date和time我們直接選擇IDEA提供的表達式
和
點擊OK,應用
在方法上面我們先輸入/**再按我們設置的快捷鍵jm+Enter即可生成方法註釋
如下:
這纔是自己想要的模板註釋,類似Eclipse風格的