解决阿里代码规范检测中方法缺少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注释内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • 详解IDEA自定义注释模板(javadoc)

    最近要开始做项目了,项目规定了方法注释模板,那么idea是如何自定义注释模板的呢? 有两种解决方案: 1.安装Jindent插件,好处是自动生成模板,但是很可惜本人安装失败,设置好以后不知道为什么无法Apply,可能是我的版本问题,失败的同学请看方案二. 2.Jindent插件下载:http://plugins.jetbrains.com/plugin/2170?pr=idea,也可以直接在idea中在线安装,类似eclipse的在线install2.使用idea自带的Live Template

  • 解决阿里代码规范检测中方法缺少javadoc注释的问题

    一.问题描述 安装了阿里代码检测的插件后,敲一个简单的方法,发现提示有问题,如下 /** * 查找User的集合 */ List<User> findAll(); 提示信息为: 方法[findAll]缺少javadoc注释 进一步查看完整文档里面关于方法注释的规范为 所有的抽象方法(包括接口中的方法)必须要用javadoc注释.除了返回值.参数.异常说明外,还必须指出该方法做什么事情,实现什么功能. 说明:如有实现和调用注意事项,请一并说明. /** * fetch data by rule

  • 去掉vue 中的代码规范检测两种方法(Eslint验证)

    我们在使用vue 脚手架时,为了规范团队的代码格式,会有一个代码规范检测,如果不符合规范就会报错,有时候我们不想按照他的规范去写.这时我们需要关闭.这里有两种方法. 1.在搭建vue脚手架时提示是否启用eslint检测的. Use ESLint to lint your code? 写 no; 2.如果项目已经生成,我们可以这样. 在项目中代开 bulid 文件夹下的 webpack.base.config.js 文件.将以下代码删掉或注销: { test: /\.(js|vue)$/, loa

  • idea中使用SonarLint进行代码规范检测及使用方法

    idea中使用SonarLint进行代码规范检测及使用方法

    安装 idea中选择file-setting-plugins,输入SonarLint,安装后重启idea 使用 重启完成后,在需要检测的单个文件或者单个项目上右键 --> Analyze --> Analyze with SonarLint 结果查看 有了代码质量检测工具以后,在一定程度上可以保证代码的质量 对于每一个问题,SonarLint都给出了示例,还有相应的解决方案,教我们怎么修改,极大的方便了我们的开发 比如,对于日期类型尽量用LocalDate.LocalTime.LocalDat

  • IDEA安装阿里代码规范插件的步骤图文详解

    IDEA安装阿里代码规范插件的步骤图文详解

    要养成一个好的编码习惯从自己编码开始,对自己代码的合理化命名,编码不仅对自己有好处,而且别人也容易读懂你的代码. 所以下载阿里的代码规范插件来约束自己凌乱的代码. 阿里规范插件GitHub地址:https://github.com/alibaba/p3c IDEA安装该插件步骤: 1.打开IDEA,File-> Setteings->Plugins->Browse Repositories,在Browse Repositories搜索栏搜索Alibaba,然后安装 2.安装完后点击   

  • 解决@Cacheable在同一个类中方法调用不起作用的问题

    解决@Cacheable在同一个类中方法调用不起作用的问题

    @Cacheable在同一类中方法调用无效 上述图片中,同一个类中genLiveBullets()方法调用同类中的queryLiveByRoom()方法,这样即便标识了Cacheable标签,再次调用时也没有走缓存. cacheable不支持内部方法调用的方式,需要修改为把请求缓存的改成service方式,Aservice中的genLiveBullets()调用Bservice中的queryLiveByRoom() 见下图,已测试再次调用时为走的缓存. @Cacheable的使用总结 @Cach

  • Java代码规范与质量检测插件SonarLint的使用

    Java代码规范与质量检测插件SonarLint的使用

    目录 1.SonarLint 2. SonarQube 3. Alibaba代码规约插件 4. 文档 1.SonarLint SonarLint是一个代码质量检测插件,可以帮助我们检测出代码中的坏味道 下载与安装 在需要检测的单个文件或者单个项目上右键 --> Analyze --> Analyze with SonarLint 或者选中文件或目录,点击菜单栏 Analyze --> Analyze with SonarLint 我们还可以禁用某些规则 如果需要同步自定义的规则时,可以绑

  • 深入浅析Python代码规范性检测

    一定要注重代码规范,按照平时的代码管理,可以将Python代码规范检测分为两种: 静态本地检测:可以借助静态检查工具,比如:Flake8,Pylint等,调研了一下,用Flake8的相对较多,功能满足,本文将使用Flake8 git:可借助git hooks,本文推荐使用pre-commit.  静态本地检测 Flake8包装了Pyflakes.Pycodestyle和McCabe,也可以自定义插件.功能包括: 检查代码是否符合PEP8 检查是否包含语法错误和未使用的变量和导入 检查代码的复杂度

  • Javadoc标签和Javadoc注释规范说明

    最近看源码,一些Javadoc常见的注释整理下 Javadoc是Sun公司提供的一个技术,从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档. Javadoc命令是用来生成自己的API文档,使用方式: javadoc 源文件名.java javadoc -d 文档存放目录 源文件名.java 通过IDEA生成Javadoc : Tools -> Generate JavaDoc javadoc标签 标签 说明 @author 作者标识 @version 版本号 @retu

  • Vue项目中使用flow做类型检测的方法

    在vue2.0的项目中加入flow类型检查.当前项目是用js写的,当项目越来越大,由于js弱类型的特性,相比ts(typescript)这种强类型的语言而言,后期维护会越来越困难.为了解决这个问题,决定使用flow 加入类型检查. flow了解 flow是fackbook公布的javascript静态类型检查器. 可以检查js中一些bug,eg:自动类型转换中出现的问题.flow官网 首先,安装flow npm i flow-bin --save-dev 然后在package.json中添加脚本

  • IDEA代码规范插件P3C+代码注释模板配置方法

    IDEA代码规范插件P3C+代码注释模板配置方法

    IDEA配置阿里规范插件P3C 进入idea ->File -> Settings ->Plugins 到搜索框中搜索:Alibaba Java Coding Guidelines 下载安装插件,安装之后重启IDEA ,进入你的编辑器右击会发现多 了,检查规范和关闭检查. 检查会发现你这个java文件是否存在问题并给出提示如: 也常常遇到类是 class 或者方法上面缺少 javadoc注解 如: 所有的类都必须添加创建者信息 所有的抽象方法(包括接口中的方法)必须要用javadoc注释

随机推荐