4

有哪些选项可以强制执行记录的代码？我想要一些将作为构建过程的一部分运行的东西，例如一个 Maven 目标，它将检查代码是否已记录（类级别和方法级别）并报告是否有任何代码缺少文档。

看过 FindBugs、PMD 和 CheckStyle，但它们似乎没有提供这种功能。

4

4 回答 4

3

好吧，我不想告诉你这一点，但有用的文档不能使用工具强制执行。

Checkstyle 可以检查Javadoc 是否存在，但它不能检查 Javadoc 是否包含任何其他内容@param pMyParam the myParam和其他无意义的垃圾。即使您让某些工具检查文档的内容，这也会产生大量误报，并导致简单但有用的评论被夸大，只是为了取悦检查工具。一段时间后，开发人员将学会在阅读代码时过滤掉 Javadocs，就像我们在阅读网页时过滤掉广告一样。因此，如果开发人员不想编写好的和有用的文档，那么所有工具都不会给你带来任何好处。

用安托万·德·圣埃克苏佩里的话来说：如果你想造一艘船，不要鼓动人们一起去收集木材，不要给他们分配任务和工作，而是要教会他们渴望永无止境大海的浩瀚。

我的建议是：使用 checkstyle 来检查非常基础的内容，例如每个类都至少有一个类型注释，并且接口也记录了它们的方法。然后，在必要时对开发人员进行有关什么是有意义和有用的文档的教育，并明确说明在开发负责人的眼中，高质量的代码具有高质量的文档。即使某些方法根本没有记录，Javadocs 也可能非常好。然后只能通过人工检查来完成检查，例如通过同行评审或质量控制过程中的某种形式化步骤。

只是我的两分钱。

于 2013-04-03T19:19:10.193 回答
1

也许它不完全是您正在寻找的，但您可以使用Sonar并在编译代码时调用它。Sonar 将提供大量信息，包括 checkstyle

Sonar 非常易于使用并与 maven 项目集成。

文档：http ://docs.sonarqube.org/display/SONAR/Installing+and+Configuring+Maven

于 2013-04-03T16:17:57.160 回答
1

Teamscale可以检查是否缺少评论。它还可以评估评论的质量并揭示琐碎和不相关的评论。

免责声明：我是 Teamscale 开发人员。

于 2016-01-29T13:30:12.497 回答
0

前段时间有一个来自 Sun 的名为 DocCheck 的 doclet。从 javadoc 创建报告。不知道还有没有。。

做一个谷歌搜索。

好的，谷歌搜索......适用于版本 1.2、1.3 和 1.4。它是实验性的，似乎是不活跃的。现在值得用吗？我不知道。那是你决定的事情。

javadoc doccheck 下载http://192.9.162.55/j2se/javadoc/doccheck/index.html

于 2013-04-03T16:24:51.240 回答