解决阿里代码规范检测中方法缺少javadoc注释的问题
更新时间：2020年08月10日 09:26:31 作者：谢康立
这篇文章主要介绍了解决阿里代码规范检测中方法缺少javadoc注释的问题，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
一、问题描述
安装了阿里代码检测的插件后，敲一个简单的方法，发现提示有问题，如下
/** * 查找User的集合 */ List<User> findAll();
提示信息为：
方法【findAll】缺少javadoc注释
进一步查看完整文档里面关于方法注释的规范为
所有的抽象方法（包括接口中的方法）必须要用javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。 说明：如有实现和调用注意事项，请一并说明。 /** * fetch data by rule id * * @param ruleId rule id * @param page page number * @param jsonContext json format context * @return Result<XxxxDO> */ Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);
二、问题分析
从阿里提供的代码规范我们可以知道以下信息：
1.要包含方法说明
2.要包含参数列表
3.要包含返回值类型
4.要严格注意注释的缩进和星号数量
而关于日期、作者、时间这些并没有做要求
所以我们可以通过添加模板的方法，来实现自动注释，避免警告
这里以IDEA为例
三、解决问题
点击 File - Settings... - Editor - Live Templates
点击右边的 + 号，选择Template Group...来新建一个模板组
输入模板组的名称，这里以myJava为例，然后在模板组下点击+号Live Template
注释文本如下，可以直接复制，除了必要的参数列表和返回值后，你还可以自定义方法名、作者、日期等等，这里不再赘述
/** * description: * @Param $PARAMS$ $RETURN$ */
点击Edit variables，一定要记得把勾都选上，return的值可以在下拉菜单找到，而Params的值请复制以下表达式
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' : '')};
return result ", methodParameters())
点击Apply或者ok，就大功告成了！
四、使用方法
编写完方法后在方法上面输入/*，再按TAB键就会自动生成模板，然后在第一行输入方法描述就符合规范啦！
注意事项：官方文档中要求@参数需要小写，如果写成了@Return就是错误的，应该写成@return
到此这篇关于解决阿里代码规范检测中方法缺少javadoc注释的问题的文章就介绍到这了,更多相关阿里代码规范缺少javadoc注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
Java 8 Stream 的终极技巧——Collectors 功能与操作方法详解
这篇文章主要介绍了Java 8 Stream Collectors 功能与操作方法,结合实例形式详细分析了Java 8 Stream Collectors 功能、操作方法及相关注意事项,需要的朋友可以参考下2020-05-05
这篇文章主要介绍了SpringCloud 提取公共配置的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
这篇文章主要介绍了mybatis-plus之如何实现in嵌套sql问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-03-03
本篇文章主要介绍了浅谈java中守护线程与用户线程，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-09-09
这篇文章主要介绍了maven打包上传到私有仓库的实现步骤，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-01-01
这篇文章主要给大家分享了 Java Unsafe 类的讲解，文章围绕Unsafe 类的相关资料展开详细内容,具有一定的参考价值需要的朋友可以参考一下2021-11-11
reduce 操作是一种通用的归约操作,它可以实现从 Stream 中生成一个值,其生成的值不是随意的,而是根据指定的计算模型,下面我们就来深入了解下java8中的reduce操作吧2023-12-12
这篇文章主要介绍了java 用语句块的正确方法实例详解的相关资料,需要的朋友可以参考下2017-01-01
这篇文章主要为大家详细介绍了Java字母大小写转换的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-06-06
这篇文章主要为大家详细介绍了Java API安全和性能方面的简单易用技巧，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-10-10
最新评论