时间戳

首页 > 解决方案 > LineLength 和 JavadocMethod 的 Checkstyle 错误

java - LineLength 和 JavadocMethod 的 Checkstyle 错误

问题描述

昨天我在个人项目 ( lifx-client ) 中更新了 Gradle 包装器（到 6.1 版）。在这个项目中，我使用Checkstyle来验证代码的一些规则。更新任务:checkstyleMain失败后出现以下错误：

$ ./gradlew checkstyleMain
> Task :checkstyleMain FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':checkstyleMain'.
> Unable to create Root Module: config {/Users/me/Projects/Miscellanea/
  lifx-client/config/checkstyle/checkstyle.xml}, classpath { ...

在使用 Checkstyle 配置文件进行一些测试后（您可以在checkstyle.xml中看到它），我发现如果我注释掉模块，错误就会消失：

    <module name="LineLength">
      <property name="max" value="120"/>
      <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>

和

    <module name="JavadocMethod">
      <property name="scope" value="public"/>
      <property name="allowMissingJavadoc" value="true"/>
      <property name="allowMissingParamTags" value="true"/>
      <property name="allowMissingThrowsTags" value="true"/>
      <property name="allowMissingReturnTag" value="true"/>
      <property name="minLineCount" value="2"/>
      <property name="allowedAnnotations" value="Override,Test,Before,Given,When,Then,And"/>
      <property name="allowThrowsTagsForSubclasses" value="true"/>
      <property name="tokens" value="METHOD_DEF"/>
    </module>

关于这个问题和/或如何解决它的任何提示？

提前谢谢。

标签： javagradlecheckstyle

解决方案

您需要从您的 checkstyle 插件中找到 checkstyle 库的确切错误消息。

您很可能在 checksyle 库中面临已知的破坏性兼容性更改。请查看https://checkstyle.org/releasenotes.html 搜索“JavadocMethod”和“LineLength”，打开相关的 Guthub 问题，您将看到“迁移说明”，其中解释了如何升级配置以解决问题。

推荐阅读