idea注释自动生成

最近在编写Spring项目,后期需要完善代码注释,可以借助idea很方便的完成。

方法注释

1、菜单栏->File->Settings->Editor->Live Templates->右上角绿色加号->1. Live Template依次点击。
Abbreviation可以设置自己喜欢的键位,我设置的是a。
点击“No applicable contexts yet.”旁边的Define,勾选需要应用的文本内容,最少得把Java相关的都给勾选。
在这里插入图片描述
在这里插入图片描述
2、输入注释的模板内容,然后点击Edit varisbles,对$$包起来的变量进行设置。

/**
  * @Description: $description$  
  * @Param: $params$  
  * @return: $returns$  
  * @Author: 我的名字 
  * @Date: $date$  
  */  

在这里插入图片描述
3、确认无误后应用。

上面做完之后,在方法内部输入a,敲击Tab选择自定义的模板,就可以自动插入注释了。
在这里插入图片描述
在Controller里面,@注解和方法名之间进行,也是可以插入的,不过在其他的Service/Repository里面,就没办法读取Param和return了。
我个人还是建议在方法体内部生成注释,然后再移动到合适的地方。

题外话:我看到其他博主有写模板少写一个/,然后输入"/a",在敲Tab选择注释模板,emm也可以吧,不过感觉有点繁琐了,如果找不到合适的键位,这样试一试也不是不可以。
在这里插入图片描述

参考资料

1、idea生成类注释和方法注释的正确方法
2、IDEA类和方法注释模板设置(非常详细)

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值