我们今天要讲的“自定义方法注解模板”,类注解模板可以很简单的设置,这里我就不重复,而网上很多关于自定义方法注解模板的文章大多是抄袭获取转发根本自己就没有验证,本文经过自己亲自验证有效。
File->settings->Editor->Live Templates
点击右上角的绿色+号,然后选择template group ,然后输入group的name,随便输入就好了:myGroup。然后点ok
选中刚才创建的myGroup,然后再次点击右侧的绿色+,这次选择的是第一个1. Live Template。取名为*,取名可以随便,只是个人觉得方便,你可以取别的。
配置模板,下面是我的模板,大家仔细看我的模板开头是而不是/,这就是关键所在。
/**
* @Description: (用一句话描述该方法做什么)
* @author xiongwu
* @date 2018/5/21 下午5:31
* @param [params, ds, ine]
* @return void
* @version V1.0
*/
注意:只有当变量被$$包围时 右侧的Edit variables才可以点击哦。
再编辑好模板之后就只为参数添加$$添加变量,点击右侧的 Editor variables,
完成之后点击Apply然后点击OK,注意了,重点的地方,在你的方法上输入 /然后加上模板的名称,这就是我为什么不取字母而取名为,因为这样很快速,再按Tab键(注意啊不是按Enter键,而是按Tab键)就会出现你想要的注释了,很多教程是直接输入模板名称按tab键,但是这种方法的@param和@return是获取不到的,再重复一遍正确的方式:/* 然后按Tab键;如果你取名为abc那就是 /*abc 然后按Tab。效果如下:
但是还有一个问题,细心的读者会发现在@param这个参数上报错了,这是因为idea强大的检查功能,有两种解决办法:
File->settings->Editor->Inspections->javadoc issues下面第四项将红色 Error改为黄色Warning即可
第二种是点击idea的右下角的人头图像,然后选择高亮级别,调为Syntax模式即可
至此已大功告成了,希望能帮到大家!