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

Question

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

有没有办法将DocCheck设置为eclipse插件？

Answer 1

这在2002年被认为是一个好主意,并且仍然在2004年被要求 ......

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

如果您确实想要获得DocCheck报告,我建议您制作一个自定义的Project Builder,就像这个一样(根本不与DocCheck相关,只是为了给您一个例子)

alt text http://www.bell-labs.com/project/nmake/manual/eclipse/jdt_lu38/builders.png

另请参阅常见问题解答如何实施增量项目构建器？或FAQ如何创建外部工具生成器？

我还建议您设置此自定义构建器,仅在执行fill build(IncrementalProjectBuilder.FULL_BUILD)时调用DocCheck ,以避免每次保存文件时等待.

最终用户可以通过在导航器中选择项目,选择"属性",然后转到" 构建器"页面来添加外部工具构建器.
在"构建选项"选项卡上,您可以指定构建器是应在autobuild,手动构建还是在Clean上运行.
在大多数情况下,在自动构建期间运行外部工具构建器太具有破坏性,因为它们运行时间过长.