validation - 是否有验证 JavaDoc 的 SonarQube 规则？

Question

我找到了一条规则，确保公共(public)方法存在 JavaDoc ->“ 公共(public)类型、方法和字段 (API) 应使用 Javadoc 记录”，但是，它似乎没有验证参数名称是正确的。例如，下面的 JavaDoc 应该会失败，因为“badName”与“aParam”不匹配。是否有另一个规则可以用来验证 JavaDoc 的文档是否正确？

/**
 * @param badName String
 */
public void myMethod(String aParam) {}

Answer 1

SonarJava 插件中没有验证 JavaDoc 参数名称的规则。搜索 all available Java rules ，与JavaDoc直接相关的只有三个:

Deprecated elements should have both the annotation and the Javadoc tag

Public types, methods and fields (API) should be documented with Javadoc

Packages should have a javadoc file 'package-info.java'

但是，如果您安装 Checkstyle plugin ，您将获得更多的 Javadoc 规则，这些规则可能与您正在寻找的内容非常接近。这是他们的一些 JavaDoc checks :

JavadocMethod:检查方法或构造函数的 Javadoc。

JavadocPackage:检查所有包是否都有包文档。

JavadocParagraph:检查 Javadoc 段落。

JavadocStyle:自定义 Checkstyle 检查以验证 Javadoc。

JavadocTagContinuationIndentation:检查 at 子句中续行的缩进。

JavadocType:检查一个类型的 Javadoc。

JavadocVariable:检查变量是否有 Javadoc 注释。