Checkstyle 10.3.1在Gradle 7.5环境下运行失败问题求助

问题根源 #

Checkstyle 10.x版本起，JavadocMethod检查器的scope属性已被移除，你的checkstyle.xml仍在使用该废弃属性，导致模块初始化失败。

解决步骤 #

• 修改Checkstyle配置文件
  找到config/checkstyle/checkstyle.xml中的JavadocMethod模块，将原来的scope属性替换为Checkstyle 10.x支持的属性：
  原配置示例：

  <module name="JavadocMethod">
      <property name="scope" value="public"/>
  </module>
  

  替换为（指定需要检查的方法范围）：

  <module name="JavadocMethod">
      <property name="allowedScopes" value="public"/>
  </module>
  

  若需排除某些范围，使用excludedScopes：

  <module name="JavadocMethod">
      <property name="excludedScopes" value="private,protected"/>
  </module>
  

• 清理Gradle冗余依赖
  删除build.gradle中的implementation("com.puppycrawl.tools:checkstyle:10.3.1")，Checkstyle插件会通过toolVersion自动管理依赖，避免版本冲突。

• 重新执行任务
  运行命令：

  ./gradlew checkstyleMain
  

补充说明 #

如果你的checkstyle.xml是从旧版本Checkstyle迁移而来，建议检查其他模块的配置是否存在类似属性变更，确保与Checkstyle 10.3.1兼容。

内容的提问来源于stack exchange，提问作者NOTiFY