idea設置類和方法的註釋模版

  1. 生成類的註釋模版
    目標是生成這樣的類註釋
    comments
    Perferences --> Editor --> File and Code Templates, 在Files頁裏面有包括 Class/Interface/Enum等的模版。上面的#parse("File Header.java")就是我們要添加註釋的位置。File and Code Templates
    點擊第二個頁籤Includes,可以看到裏面有個File Header選項,可以在裏面編輯我們的註釋模板。
    添加代碼:
/**
* @author ${USER}
* @version V1.0
* @description TODO
* @date ${DATE} ${TIME}
*/

File Header
所有寫有#parse("File Header.java")的文件都會在創建的時候生成這段註釋。

  1. 生成方法的註釋模版
    目標是生成這樣的方法註釋,參數隨着實際個數的改變而改變。
    方法註釋
    在Live Templates中,點擊右上角的+,選擇Templates group,取名爲methodTemplates。
    Template group
    再次點擊+,選擇Live Template,創建一個註釋模版。

Live Template
由上圖所示,Abbreviation表示生成代碼的快捷鍵,這裏使用*,Description是簡單的描述,Expand with中的enter表示,在輸入*之後按下enter鍵就會生成Template text中的代碼。
在Template text寫入註釋的模板。我們的習慣是先輸入/**再按下enter鍵來生成模版,所以這裏要在前面去掉/*,用第二個*生成模版。
添加代碼:

*
 * @title $title$
 * @description $description$
 * @author $user$
 * @date $date$ $TIME$ $param$
 * @return $return$
 */

最後,在Edit variables中編輯模版的屬性。
Edit variables
有兩點要注意,一個是TODO要用"包起來,第二個,param參數要寫在Default value中,而不是Expression中,很多其他文章可能都是直接複製,沒有自己試驗過。
複製以下代碼:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

ps:可能生成註釋之後會有下面這樣的紅框,沒關係,在按一下enter就會消除。
紅框

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