类模板
选择File –> Settings –> Editor –> File and Code Templates
–> Includes –> File Header
/** * 类的描述 * * @author ${USER} * @date ${DATE} ${HOUR}:${MINUTE} * @version v1.0 * @modified by */
设置完成后,新建类时自动生成注释
方法模板
Idea没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下
- 选择File –> Settings –> Editor–>
Live Templates
,先选择右侧绿色加号新建一个自己的模板组,如图命名为myGroup
- 选中已建好的组,选择右侧绿色加号新建模板
- 填好Abbreviation(快捷输入:
/**
),Description(描述)和模板内容 - 点击Define,勾选Java (如果曾经修改过,则显示为change而不是define)
- 点击Edit variables编辑变量,设置如下,点击Ok –> Apply完成设置
- 输入
/**
,然后按Enter(Tab键)即可生成注释
注意此方式有个缺点,需要在方法内部生成,否则@param为null
改成这样了,按/** + enter 就可以获取到param跟return了
/** * 方法说明 * * @author $user$ * @date $date$ $time$ $params$ * @return $return$ * @exception: $exception$ * @modified By */
其中params需要写脚本,内容如下:
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()) //groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').s