hello云胜

技术与生活

0%

发表于

Idea添加注释

类注释

注释模板

1
2
3
4
5
6
7
8
9
/**
 *
 *
 *@description: 
 *@author: yunsheng
 *@time: ${DATE} ${TIME}
 * 
 */

配置方法

File–Settings搜索Templates，选File and Code Templates的Class、Interface等等进行配置

image-20210519093912830

可以看到下面有很多参数配置可以使用

效果

在新建类时会自动带上配置的模板

image-20210519094115219

快捷键方法注释

配置方法

使用File–Setting–Live Templates。

  1. 先创建一个自己的分组

image-20210519100334243

2，创建模板

然后在刚才创建的分组下，新建模板

image-20210519100649645

模板

1
2
3
4
5
6
7
8
9
/**
 *
 * @description: 
 $params$
 * @return: $return$
 * @author: yunsheng
 * @time: $date$ $time$
 */

image-20210519101022248

3,变量设置

上一步中的模板里，$params$等是变量，idea现在并不能识别，需要进行一些配置。

点击Edit variables

image-20210519103911702

在方法内部按下m，自动生成注释

image-20210519104013504

但是参数这里比较丑，使用自定义函数进行一下格式化。groovyScript 函数调用 Idea 的 methodParameters() 函数获得参数数组，并进行格式化。

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

image-20210519104227636

再看下效果

image-20210519104519870

但是这有个缺点，只有在方法内部使用时才能获取到参数和返回值的类型。我们一般的习惯是方法注释放在方法定义的上边。所以这种配置我个人觉得很鸡肋。我更喜欢在方法上直接/**回车自动生成注释。

一般我们用这种快捷键来写固定的代码比较舒服。

比如psvm就是main方法的快捷键。psfs是string常量的快捷写法。