脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → 阿里代码规范缺少javadoc注释

解决阿里代码规范检测中方法缺少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中HashMap与String字符串互转的问题解决

    Java中HashMap与String字符串互转的问题解决

    本文介绍了Java中HashMap与String字符串互转的问题解决，当我们有需求将HashMap转为Json格式的String时，需要使用FastJson/Gson将HashMap转为String，感兴趣的可以了解一下
    2022-03-03
  • Java代理模式的示例详解

    Java代理模式的示例详解

    代理模式（Proxy Parttern）为一个对象提供一个替身，来控制这个对象的访问，即通过代理对象来访问目标对象。本文将通过示例详细讲解一下这个模式，需要的可以参考一下
    2022-02-02
  • java poi导入纯数字等格式问题及解决

    java poi导入纯数字等格式问题及解决

    这篇文章主要介绍了java poi导入纯数字等格式问题及解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-03-03
  • Java中-Xms和-Xmx参数的使用与默认内存设置

    Java中-Xms和-Xmx参数的使用与默认内存设置

    在 Java 程序运行时,内存的管理是影响程序性能的关键因素之一,Java 程序使用的内存主要由两部分组成：堆内存和栈内存,Java 提供了多个参数来控制堆内存的大小,其中最常用的参数是 -Xms 和 -Xmx,本文将详细介绍这些参数,需要的朋友可以参考下
    2024-11-11
  • Java基础MAC系统下IDEA连接MYSQL数据库JDBC过程

    Java基础MAC系统下IDEA连接MYSQL数据库JDBC过程

    最近一直在学习web项目，当然也会涉及与数据库的连接这块，这里就总结一下在IDEA中如何进行MySQL数据库的连接，这里提一下我的电脑是MAC系统，使用的编码软件是IDEA，数据库是MySQL
    2021-09-09
  • Java中的静态代码块使用解读

    Java中的静态代码块使用解读

    本文将深入探讨静态代码块的工作原理、使用场景以及一些最佳实践,帮助你更好地理解和应用这一特性
    2025-02-02
  • 详解如何保护SpringBoot配置文件中的敏感信息

    详解如何保护SpringBoot配置文件中的敏感信息

    使用过SpringBoot配置文件的朋友都知道，资源文件中的内容通常情况下是明文显示，安全性就比较低一些，所以为了提高安全性，就需要对配置文件中的敏感信息进行保护，下面就为大家介绍一下实现方法吧
    2023-07-07
  • JAVA多线程之中断机制及处理中断的方法

    JAVA多线程之中断机制及处理中断的方法

    这篇文章主要记录使用 interrupt() 方法中断线程，以及如何对InterruptedException进行处理，感觉对InterruptedException异常进行处理是一件谨慎且有技巧的活儿,需要的朋友可以参考下
    2023-02-02
  • Java批量写入文件和下载图片的示例代码

    Java批量写入文件和下载图片的示例代码

    这篇文章主要介绍了Java批量写入文件和下载图片的示例代码，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
    2020-09-09
  • java对象转型实例分析

    java对象转型实例分析

    这篇文章主要介绍了java对象转型的概念及用法,并以实例形式进行了较为详细的介绍,需要的朋友可以参考下
    2014-10-10

最新评论