解决阿里代码规范检测中方法缺少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注释内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞！
相关文章
- 本文主要介绍了C#中注释的相关知识，具有很好的参考价值，下面跟着小编一起来看下吧...2020-06-25
- C#注释的一些使用方法浅谈，需要的朋友可以参考一下...2020-06-25
- 这篇文章主要介绍了IDEA插件之快速删除Java代码中的注释,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-02-18
- 这篇文章主要介绍了R语言-使用快捷键快速注释的实现方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-05-06
- 这篇文章主要介绍了解决阿里代码规范检测中方法缺少javadoc注释的问题，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-08-10
- 这篇文章主要介绍了PyCharm设置注释字体颜色以及是否倾斜的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-16
- 下面小编就为大家带来一篇老生常谈javascript变量的命名规范和注释。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧...2016-10-02
VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)
这篇文章主要介绍了VSCode 添加自定义注释的方法(附带红色警戒经典注释风格),本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2020-08-28- 阿里云DNS解析是刚出来不久的，介理阿里云是万网作后台的，而dnspod是一直专业做一块的那么们两那个更好一些呢，下面来看一个简单的对比。 虽然DNSPOD已经占据了大半个...2016-10-10
- Namecheap平台的域名出得早并且在国内没出就有可能可以在Namecheap平台注册域名了，小编最近收了一个Namecheap平台的域名需要转入万网了，今天我们整理了一篇关于Nameche...2016-10-10
- 在C/C++,JAVA中，有两种注释，一种是单行注释，即两根反斜杠(//)，另一种是多行注释，即以/*开头，以*/结尾,本文将详细介绍，需要的朋友可以参考下...2020-06-25
- 为了方便别人或自己阅读自己的程序，注释是坚决不可少的,一个漂亮的程序，不是在于你应用的技术多么高深，而是能够把高深的技术描述的清楚易懂...2020-04-25
- 这篇文章主要介绍了实现去除c语言注释的小工具，说是C语言，但其实所有C语系的都可以，比如Java,需要的朋友可以参考下...2020-04-25
- 本文将实例讲述C#中如何使用免费组件给PDF文档添加文本注释，包括自由文本注释。自由文本注释能允许我们自定义它的风格和外观，非常具有实用价值...2020-06-25
- 自 2016 年 7 月并入阿里移动后，豌豆荚创始团队的命运揭晓。阿里巴巴刚召开发布会，宣布对豌豆荚并购整合完成，豌豆荚与阿里移动其他分发平台——阿里游戏·九游、PP 助手、UC 应用商店、神马搜索、YunOS 应用商店成立阿里应用分发。豌豆荚联合创始人王俊煜就在圣诞节前一天披露了新动向——成立新公司，轻芒。...2016-12-31
在IntelliJ IDEA中为自己设计的类库生成JavaDoc的方法示例
这篇文章主要介绍了在IntelliJ IDEA中为自己设计的类库生成JavaDoc的方法示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-08-10- PHP是现在非常热门的编程语言，这次文章就给大家介绍下PHP字符串、语句结束符、注释怎么运用？对此感兴趣的伙伴赶紧来看看。 不同于HTML和CSS，在php中我们可以做计算，...2017-07-06
- 平常开会或者做总结报告的时候我们通常都会用到PowerPoint演示文稿，我们可以在单个幻灯片或者全部幻灯片里面添加注释，这样观众可以从注释内容里面获取更多的相关信息,需要的朋友可以参考下...2020-06-25
- 本文提供了c#删除代码中的单行注释行的示例,还可以看到文件流的使用方法，大家参考使用吧...2020-06-25
Python注释、分支结构、循环结构、伪“选择结构”用法实例分析
这篇文章主要介绍了Python注释、分支结构、循环结构、伪“选择结构”用法,结合实例形式分析了Python注释、分支结构、循环结构、伪“选择结构”相关功能、用法及操作注意事项,需要的朋友可以参考下...2020-04-27