網上找了一下,沒有很詳細且正確介紹Idea配置註釋模板的,於是結合多篇文章自己琢磨整理出如下。
設置類註釋模板
1.選擇File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
2.在右邊空白處,編寫自己的模板即可,注意Scheme是模板的生效範圍,可選變量在description有介紹,附圖中本人使用的模板(${USER}爲計算機用戶名,可以自行修改)。
/**
* @Auther: ${USER}
* @Date: ${DATE} ${HOUR}:${MINUTE}
* @Description:
*/
3.設置完成後,創建類時自動生成註釋,效果如下。
設置方法註釋模板
Idea沒有可以直接設置方法註釋模板的地方,可以借用Live Templates基本實現,步驟如下。
1.選擇File–>Settings–>Editor–>Live Templates,先選擇右側綠色加號新建一個自己的模板組,如圖命名爲myGroup。
2.選中已建好的組,選擇右側綠色加號新建模板,如下圖。
3.填好Abbreviation(快捷輸入),Description(描述)和模板內容(圖中模板如下)
/**
*
* 功能描述:
*
* @param: $param$
* @return: $return$
* @auther: $user$
* @date: $date$ $time$
*/
4.點擊Define,勾選Java
5.點擊Edit variables編輯變量,設置如下,點擊Ok–>Apply完成設置。
6.輸入“/**”,然後按Tab鍵即可生成註釋,如下圖。注意此方式有個缺點,需要在方法內部生成,否則@param爲null。