idea設定方法註釋
阿新 • • 發佈:2021-08-03
1、給建立的檔案自動添加註釋資訊
2、idea方法註釋,系統預設的只能獲取到引數,無法獲取返回值,如下:
/** * * @param id * @param type * @return */ public static String getName(Long id, int type) { return null; }
使用Eclipse時我們生成註釋的習慣是/**+Enter,這裡我們也按照這種習慣來設定IDEA的方法註釋
1. File-->Settings-->Editor-->Live Templates
1.1 新建Template Group: 命名為 MethodBingtai
1.2 在MethodBingtai下新建Live Template,命名為*
因為IDEA生成註釋的預設方式是:/* +模板名+快捷鍵(比如若設定模板名為add快捷鍵用Tab,則生成方式為/*add+Tab),如果不採用這樣的生成方式IDEA中沒有內容的方法將不可用,例如獲取方法引數的methodParameters()、獲取方法返回值的methodReturnType() 作者:味道_3a01 連結:https://www.jianshu.com/p/2b17c3879879 來源:簡書 著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。
1.3 設定註釋的快捷鍵
1.4 設定模板
模板內容如下:
* * 功能描述: <br> * 〈$END$〉 * @Param: $param$ * @Return: $return$ * @Author: $user$ * @Date: $DATE$ $TIME$ */
注意第一行,只有一個* 而不是/*
在設定引數名時必須用$引數名$
的方式,否則1.5中讀取不到你設定的引數名
1.5 設定引數的獲取方式
選擇右側的Edit variables
按鈕
選擇每個引數對應的獲取方法(在下拉選擇框中選擇即可),網上有很多教程說獲取param時使用指令碼的方式,我試過使用指令碼的方式不僅麻煩而且只能在方法內部使用註釋時才能獲取到引數
選擇應用場景:勾選Java
注意 點選模板頁面最下方的警告,來設定將模板應用於那些場景,一般選擇Java即可(如果曾經修改過,則顯示為Change
而不是Define
)
再次選擇右側的Edit variables
按鈕,下拉框就有選項了;如下圖,選中對應的Expression
,點選OK
2. 效果
建立方法,在方法上一行,輸入 /** ,然後 回車
作者:味道_3a01
連結:https://www.jianshu.com/p/2b17c3879879
來源:簡書
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。