是否有SonarQube规则来验证JavaDoc？

Question

我找到了一条规则，确保公共方法存在JavaDoc - ＆gt; “公共类型，方法和字段（API）应使用Javadoc ”进行记录，但是，它似乎不会验证参数名称是否正确。例如，下面的JavaDoc应该失败，因为'badName'与'aParam'不匹配。是否有其他可用于验证JavaDoc的规则是否正确记录了？

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

Answer 1

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

1. Deprecated elements should have both the annotation and the Javadoc tag
2. Public types, methods and fields (API) should be documented with Javadoc
3. 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注释。