Checkstyle 的 PackageHtml 规则忽略 package-info.java

【问题标题】：Checkstyle's PackageHtml-rule ignores package-info.javaCheckstyle 的 PackageHtml 规则忽略 package-info.java
【发布时间】：2010-09-15 11:48:03
【问题描述】：

我使用 checkstyle 来分析我的代码。一个有用的规则是 PackageHtml，它检查包是否包含 Javadoc 描述。但是对于较新的 java 版本，建议使用 package-info.java 而不是 package.html。问题是，checkstyle 忽略 package-info.java 并报告违反规则。如何将 checkstyle 配置为检查包文档，但接受 package.html 和 package-info.java？

【问题讨论】：

标签： xml javadoc checkstyle

【解决方案1】：

您使用的是哪个版本的 CheckStyle？

这似乎是 2007 年底关闭的 old bug。

实际上，文档中提到 package-info 为 being the default!... 但仅适用于 CheckStyle 5.x，而非 4.4

CheckStyle5.0 beta1 is here的公告。
CheckStyle 4.4 是最后一个兼容 jdk1.4 的版本

【讨论】：

我用的是稳定版。你说这在即将发布的版本中有效吗？那会很酷。那我就等不及新版本了。
是的，checkstyle 5.5 是更面向JDK5或者JDK6的，不过相信你现在就可以用了。
谢谢，它工作正常。由于我不想过分依赖 beta 版本，我希望他们能快速进入最终版本。
感谢您的积极反馈。 checkstyle 5.0 正式发布后，我会更新这篇文章。