查找没有 Javadoc 的 Java 类、函数和成员
我曾经使用 Doxygen,它生成了一份不错的报告,列出了尚未记录的项目。有什么方法可以在 Eclipse Java 项目中生成类似的缺少 Javadoc 注释的报告吗?
I used to use Doxygen, which produced a nice report listing items that were had not been documented. Is there any way I can generate a similar report of missing Javadoc comments in an Eclipse Java project?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
它本身并不是一个“报告”,但您可以将 Eclipse 配置为将丢失(和格式错误)的 JavaDoc 注释报告为警告甚至错误。
您可以基于每个工作空间(窗口 -> 首选项 -> Java -> 编译器 -> Javadoc)或基于每个项目(选择项目 -> 右键单击 -> 属性)来执行此操作-> Java 编译器 -> Javadoc)。
It's not a "report" as such, but you can configure Eclipse to report missing (and malformed) JavaDoc comments as warnings or even errors.
You can do that either on a per-workspace basis (Window -> Preferences - > Java -> Compiler -> Javadoc) or on a per-project basis (select project -> Right-Click -> Properties -> Java Compiler - > Javadoc).
如果您想要跨 IDE(或更确切地说非 IDE)解决方案,您也可以使用 Checkstyle,可以配置为检查各个级别的javadoc(包、类、方法等)
If you want a cross-IDE (or rather a no-IDE) solution, you might also use Checkstyle, which can be configured to check javadoc on various levels (package, classes, methods, etc.)