最近在编写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也可以吧,不过感觉有点繁琐了,如果找不到合适的键位,这样试一试也不是不可以。