idea自动生成方法注释(含参数及返回值)

程序员到新的公司上班,拿到新电脑当然要第一时间配置好各种开发环境和开发工具。

在idea中打开设置,选择File->settings->Editor->Live Templates

点击”+”->选择template group ,然后输入group的name,如annotation。
然后,选中刚才创建的myGroup,然后再次点击右侧的绿色+,这次选择的是Live Template。取名(Abbreviation)为*。Description中填写”方法注释”

配置模板

选择刚刚添加的Live Template,在下面的Text Template中添加下面的内容,注意不要整理下面的格式。

1
2
3
4
5
6
7
8
*
*
* $VAR1$
$params$
* @return $returns$
* @author 19037900@xx.cn
* @date $date$ $time$
*/

注意:此处一定要为刚刚的模板指定使用范围,选择全部就行了。

配置variables,点击 Edit variables

VAR1参数不用管
params (网上好多都不行,这个是我正在用的)

1
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'+'\\b' : '')}; return result", methodParameters())

returns参数可以下拉,选择methodReturnType();
date参数可以下拉,选择date();
time参数可以下拉,选择time();

配置快捷键,点击Edit variables下面的Options中的Expand with下拉选择Enter。

开始使用

输入 /**,然后Enter,大功告成

  • 作者: Sam
  • 发布时间: 2019-04-22 23:35:02
  • 最后更新: 2020-12-06 22:02:12
  • 文章链接: https://ydstudios.gitee.io/post/526abd46.html
  • 版权声明: 本网所有文章除特别声明外, 禁止未经授权转载,违者依法追究相关法律责任!