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就会消除。
红框

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