解决阿里代码规范检测中方法缺少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压缩/解压文件的实现代码

    Java压缩/解压文件的实现代码

    本文通过实例代码给大家分享了Java压缩/解压文件的方法,需要的朋友参考下吧
    2017-09-09
  • 简单了解Java中的可重入锁

    简单了解Java中的可重入锁

    这篇文章主要介绍了简单了解Java中的可重入锁,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • Mybatis 简介与原理

    Mybatis 简介与原理

    MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
    2017-05-05
  • Java操作MinIO实现文件的上传和删除

    Java操作MinIO实现文件的上传和删除

    本文主要介绍如何将本地Java项目resources目录下的一个PNG图片上传到MinIO,然后将上传的图片删除,文中有详细的流程步骤和示例代码,需要的朋友可以参考下
    2023-06-06
  • SpringBoot替换默认的tomcat服务器的方法

    SpringBoot替换默认的tomcat服务器的方法

    Tomcat是Apache基金下的一个轻量级的Servlet容器,支持Servlet和JSP,Tomcat具有Web服务器特有的功能,在SpringBoot框架中,我们使用最多的是Tomcat,这是SpringBoot默认的容器技术,本文给大家介绍了Spring Boot如何替换默认的tomcat服务器,需要的朋友可以参考下
    2024-08-08
  • Java将集合List转换成String字符串(或String转换成List)详解

    Java将集合List转换成String字符串(或String转换成List)详解

    今天在写项目的时候遇到一个问题,就是要把得到的一个集合转换成字符串,下面这篇文章主要给大家介绍了关于Java将集合List转换成String字符串(或String转换成List)的相关资料,需要的朋友可以参考下
    2023-06-06
  • Spring 注入集合实现过程示例详解

    Spring 注入集合实现过程示例详解

    这篇文章主要为大家介绍了Spring 注入集合实现过程示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • Java异常处理操作 Throwable、Exception、Error

    Java异常处理操作 Throwable、Exception、Error

    这篇文章主要介绍了Java异常处理操作 Throwable、Exception、Error,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • 一小时迅速入门Mybatis之Prepared Statement与符号的使用

    一小时迅速入门Mybatis之Prepared Statement与符号的使用

    这篇文章主要介绍了一小时迅速入门Mybatis之Prepared Statement与符号的使用,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • Java ThreadLocal 线程安全问题解决方案

    Java ThreadLocal 线程安全问题解决方案

    这篇文章主要介绍了Java ThreadLocal 线程安全问题解决方案的相关资料,需要的朋友可以参考下
    2016-09-09

最新评论