1.類自動注釋
左上角選擇 File -> Settings -> Editor -> File and Code Templates,
選擇Files -> Class,在類聲明上填入以下內容,並勾選Enable Live Templates 開啟此模板
其中${}為變量,可以使用默認自帶的變量,在Description中有詳細的列舉,如果是自定義的變量,創建Class的時候會要求輸入
/** * @description:TODO * @author :xxx * @date :${DATE} ${TIME} */
檢驗自動生成:
2.方法自動注釋
左上角選擇 File -> Settings -> Editor -> Live Templates,
點擊加號,選擇Template Group
輸入任意名稱
創建完成后,自動定位到剛創建的組,點擊右上角,選擇Live Template
自定義任意的Abbreviation,這里為了以后操作快捷,直接填寫a
Template Text 內填入以下內容 (可根據個人需求自行修改),$xx$為自定義變量,可以手動輸入,也可以選擇自帶的函數
/** * @author: $author$ * @description: TODO * @date: $date$ $time$ $params$ * @return $returns$ */
然后點擊Edit variables ,配置變量
author為作者,可自定義內容;
date、time為時間,這里使用自帶的函數;
returns為返回值,這里也使用自帶的函數;
params為方法入參數,這里需要配置groovyScript函數,將下面的內容拷貝到Expression
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())
填寫后點擊OK,最后選擇適用范圍,選擇java,點擊打勾
到這里配置就完成了,隨便找一個方法,在方法上部輸入剛剛設置的Abbreviation,這里是a,所以輸入a,然后按Tab鍵就可以自動生成
這里有個小問題,生成的時候如果不在方法體內,入參如果不是vo等java類,就獲取不到,所以建議在方法體內生成,然后移到方法上面
另:方法體外生成的位置必須是方法上部一行,如果在@Override上面使用就獲取不到入參和返回值了,所以這里只能先生成注釋,然后再把@Override等方法注解移到下面(不移也沒關系,但不美觀)