IDEA類和方法註釋模板設置

一、首先我們來設置IDEA中類的模板:(IDEA中在創建類時會自動給添加註釋)

1、File-->settings-->Editor-->File and Code Templates-->Files

我們選擇Class文件(當然你要設置接口的還也可以選擇Interface文件)

(1)${NAME}:設置類名,與下面的${NAME}一樣才能獲取到創建的類名

(2)TODO:代辦事項的標記,一般生成類或方法都需要添加描述

(3)${USER}、${DATE}、${TIME}:設置創建類的用戶、創建的日期和時間,這些事IDEA內置的方法,還有一些其他的方法在綠色框標註的位置,比如你想添加項目名則可以使用${PROJECT_NAME}

(4)1.0:設置版本號,一般新創建的類都是1.0版本,這裏寫死就可以了

2、效果圖展示

二、設置方法註釋模板

IDEA還沒有智能到自動爲我們創建方法註釋,這就是要我們手動爲方法添加註釋,使用Eclipse時我們生成註釋的習慣是

/**+Enter,這裏我們也按照這種習慣來設置IDEA的方法註釋

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

(1)新建組:命名爲userDefine

(2)新建模板:命名爲*

因爲IDEA生成註釋的默認方式是:/*+模板名+快捷鍵(比如若設置模板名爲add快捷鍵用Tab,則生成方式爲

/*add+Tab),如果不採用這樣的生成方式IDEA中沒有內容的方法將不可用,例如獲取方法參數的methodParameters()、

獲取方法返回值的methodReturnType()

(3)設置生成註釋的快捷鍵

(4)設置模板:模板內容如下

注意第一行,只有一個*而不是/*

在設置參數名時必須用${參數名}$的方式,否則第五步中讀取不到你設置的參數名

 

*
 * @Author chengpunan
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

如果使用/*生成的模板註釋將會是如下效果:所以我們要去掉最前面的/*

(5)設置參數的獲取方式

選擇右側的Edit variables按鈕

選擇每個參數對應的獲取方法(在下拉選擇框中選擇即可),網上有很多教程說獲取param時使用腳本的方式,我試過使用腳本

的方式不僅麻煩而且只能在方法內部使用註釋時才能獲取到參數

(6)設置模板的應用場景

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

(如果曾經修改過,則顯示爲change而不是define)

(7)效果圖

創建方法,在方法上面寫:/*+模板名+Enter-->/**+Enter

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章