java - 如何将 JavaDoc DocCheck 设置为 Eclipse 插件？

Question

我最近开始使用 DocCheck 来检查代码文件中 JavaDoc 的有效性。

有什么方法可以将 DocCheck 设置为 eclipse 插件吗？

Answer 1

这被认为是个好主意 back in 2002 ，还有asked for in 2004 ...

但从那时起，几乎所有 Sun Doc Check Doclet 的功能(最初为 Sun 内部使用而开发并发布给开发人员社区以按原样使用的实验代码)在 Java 项目属性的“Java Compiler/Javadoc”部分中几乎涵盖了(尽管没有HTML rapports 输出)

如果您确实想要 DocCheck 报告，我建议您制作一个 custom Project Builder , 比如 this one (与DocCheck完全无关，只是举个例子)

_{(来源:bell-labs.com)}

另见 FAQ How do I implement an incremental project builder? 或 FAQ How do I create an external tool builder?

我还建议您将此自定义构建器设置为仅在执行填充构建时调用 DocCheck (IncrementalProjectBuilder.FULL_BUILD)，以避免每次保存文件时都等待。

End users can add external tool builders by selecting a project in the Navigator, choosing Properties, and then going to the Builders page.
On the Build Options tab, you can specify whether the builder should run on autobuild, manual build, or on Clean.
In most cases, running external tool builders during auto-builds is too disruptive because they are too long running.