IntelliJ IDEA中设置自动生成Java类注释、方法注释(以及处理param数组问题)

一、设置类注释自动生成

1.方法1

file-->Settings-->File and Code Templates-->includes-->File Header

在这里插入图片描述

  • 模板(加冒号看着有点丑,所以模板去掉了,你喜欢就加上):
/**
 * @Description 
 * @Author susu
 * @Date $DATE
 */
  • 效果(创建文件之后自动生成):
    在这里插入图片描述
    在这里插入图片描述

2.方法2

...-->File and Code Templates-->Files-->Class

在这里插入图片描述

  • 模板
/**
* @FileName ${NAME}
* @Description 
* @Author liuXXX
* @date ${YEAR}-${MONTH}-${DAY}
**/
  • 效果(加冒号看着有点丑,所以模板去掉了,你喜欢就加上)
    在这里插入图片描述
  • 如果你要设置接口,再对接口做同样操作即可

3.对比

  • 看个人喜欢了,我个人更倾向于方法1,因为只需要设置一次就可以了,方法二,我们刚是对Class进行设置的,如果想对interface进行设置的话,还需要再设置一次,当然看你喜欢,你喜欢哪个用哪个呗

二、设置方法注释自动生成

1. param是以数组的形式生成

  • 第一步:
    在这里插入图片描述
    在这里插入图片描述
  • 第二步
    在这里插入图片描述
  • 第三步
    在这里插入图片描述
  • 第四步
    忘了截这一步,补一下:
    在这里插入图片描述
  • 第五步:需要注意的是:
    在这里插入图片描述

模板

**
* @Description  
* @param $param$
* @return $returns$
* @Author liuXXX
* @Date $date$
*/

效果

  • 使用的时候,在方法上输入/ss(我上面设置的快捷键是ss)
    在这里插入图片描述
    在这里插入图片描述

2. param正常换行生成

  • 从上面我们看到生成的参数是@param : [a, b] 这种形式不是我们想要的,当然如果你觉得ok,那你用也没啥
  • 那这种问题怎么解决呢,想增加奇怪的知识,那就请继续往下看:
    在上面的基础上,我们只需要修改两处即可:
    在这里插入图片描述
    修改完成之后应用即可,但是如果你网上百度的,修改完成之后,发现下面等问题(对不齐,很难受):
    在这里插入图片描述

(1)修改之后的模板

**
* @description: 
$params$
* @return $returns$
* @author susu
* @date $date$
*/

(2)设置params的Experssion

  • 上面说的那个对齐问题的处理我们只需要修改一下第二处填写的代码逻辑即可,正确的代码内容如下:
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'+'\\t' : '')
}; 
return result", methodParameters()
)

(3)效果图

  • 修改完成之后的效果图(那个框框不影响你,随便修改一下或者空格一下或者回车就ok了):
    在这里插入图片描述
    好了,到这里就完美解决了,想用哪个看你自己选择了!
  • 19
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

@素素~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值