Netbeans 中是否存在缺少 JavaDoc 警告?

Is there a missing JavaDoc warning in Netbeans?

我正在学习 AP 计算机科学,我的老师要求我学习 JavaDocs。我想知道是否有办法确保 none 丢失。我正在为 class 使用 Netbeans,但我相信其他人也想知道它是否也适用于其他 IDE。另外,有没有办法自动添加空的 JavaDocs?感谢大家的帮助。

您正在寻找 checkstyle 插件,它会在没有方法的 javadoc 的情况下向您显示警告。

您可以使用名为 JAutoDoc 的插件在 Eclipse 中自动生成它们。 Netbeans 4.0 及更高版本具有称为自动评论的功能,可将您的评论格式化为 Javadoc-compliant 并标记任何缺失的内容,因此这似乎是您所追求的。

查看 https://netbeans.org/competition/win-with-netbeans/auto-comment.html 了解详细信息,但要点是您从工具菜单 select "Auto Comment"。

在 NetBeans 中,select 项目 window 中的项目,然后 select "Tools" 菜单中的 "Analyze Javadoc" 项。这将生成一份报告,详细说明项目中丢失或错误(例如缺少参数)的 Javadoc。我已经在 Netbeans 10.0 中亲自测试了这个功能,但我相信它至少从 8.1 版开始就有了。

作为 select 在项目 window 中构建整个项目的替代方法,您还可以 select 包的子组或 类 进行检查。如果您对将 Javadoc 添加到您的单元测试不感兴趣,这将特别有用:您可以只对它们使用 select "Source Packages" 和 运行 "Analyze Javadoc" 而不会产生关于 类 在 "Test Packages" 组中。