SonarQube是否有校验JavaDoc参数名正确性的规则？

当然有解决办法！你遇到的这种JavaDoc @param标签参数名和方法实际参数不匹配的问题，主流的静态代码分析工具都提供了专门的校验规则，下面给你详细说说几个常用选项：

• Checkstyle：这是最常用的Java代码规范检查工具之一，其中JavadocMethod规则默认就包含了参数名匹配的校验逻辑。只要开启这个规则（默认是开启状态），它会自动检查每个@param标签里的参数名是否和方法定义的参数名完全一致。像你给出的示例代码，Checkstyle会直接抛出违规提示，明确指出@param badName没有对应的方法参数aParam。如果需要自定义配置，你可以在Checkstyle的XML配置里调整相关属性：

  <module name="JavadocMethod">
      <!-- 确保校验参数名匹配（默认就是true，可省略） -->
      <property name="checkParameterNames" value="true"/>
      <!-- 强制要求每个方法参数都有对应的@param标签 -->
      <property name="requireParamTags" value="true"/>
  </module>
  

• PMD：PMD也有针对性的规则来处理这个问题：

  • JavadocInvalidParamName规则专门校验@param标签中的参数名是否与方法实际参数名一致，正好解决你的场景；
  • 搭配JavadocMissingParamTag规则，还能确保每个方法参数都存在对应的@param标签，进一步提升JavaDoc的完整性。

• IntelliJ IDEA内置检查：如果你日常用IntelliJ IDEA开发，它的内置代码检查功能里就自带了「Javadoc parameter name does not match method parameter」的规则，默认处于开启状态。在你编写代码时，IDE会实时给出红色提示，不用等到静态分析阶段就能发现这类错误，非常高效。

这些工具的规则不仅能解决参数名匹配的问题，还能扩展检查其他JavaDoc质量问题，比如缺失@return、@throws标签，或者标签描述不符合规范等，比你现有的基础规则覆盖得更全面。

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