阿里代码规范检测中方法缺少javadoc注释怎么办

提示信息为:

方法【findAll】缺少javadoc注释

进一步查看完整文档里面关于方法注释的规范为

所有的抽象方法(包括接口中的方法)必须要用javadoc注释,除了返回值,参数,异常说明外,还必须指出该方法做什么事情,实现什么功能。说明:如有实现和调用注意事项,请一并说明。/* *
　　*获取数据规则id
　　*
　　* @param ruleId规则id
　　* @param页页码
　　* @param jsonContext json格式的上下文
　　* @return Result
　　*/ResultfetchDataByRuleId(长ruleId,整页,字符串jsonContext); 

从阿里提供的代码规范我们可以知道以下信息:

1。要包含方法说明
2。要包含参数列表
3。要包含返回值类型
4。要严格注意注释的缩进和星号数量

而关于日期,作者,时间这些并没有做要求

<强>所以我们可以通过添加模板的方法,来实现自动注释,避免警告

这里以理念为例

点击文件<代码> - <代码>设置… - <代码> 编辑<代码>生活模板

点击右边的<代码> + 号,选择<代码>模板组…>

输入模板组的名称,这里以myJava为例,然后在模板组下点击<代码> +> 生活模板

注释文本如下,可以直接复制,除了必要的参数列表和返回值后,你还可以自定义方法名,作者,日期等等,这里不再赘述

/* * 　　*描述: 　　* @Param PARAMS美元 　　返回美元 　　*/

点击<代码> 编辑变量,一定要记得把勾都选上,返回的值可以在下拉菜单找的到,而参数的值请复制以下表达式

groovyScript ( 　　“def结果=& # 39;& # 39;; 　　def params=\“$ {_1} \“.replaceAll (& # 39; [\ \ \ \ [| \ \ \ \] | \ \ \ \ s] & # 39;, & # 39; & # 39;) .split (& # 39; & # 39;) .toList (); 　　(我=0;我& lt;params.size ();我+ +){ 　　结果+=& # 39;* @param & # 39;+ params[我]+(我& lt;params.size () - 1), # 63;& # 39;\ \ n # 39;:& # 39;& # 39;)}; 　　返回结果“methodParameters ()

点击或<代码>适用者<代码> ,就大功告成了!

编写完方法后在方法上面输入<代码>/*> 选项卡>

注意事项:官方文档中要求<代码> @参数> @Return> @Return

感谢各位的阅读!关于阿里代码规范检测中方法缺少javadoc注释怎么办就分享到这里了,希望以上内容可以对大家有一定的帮助,让大家可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到吧!

阿里代码规范检测中方法缺少javadoc注释怎么办