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

时间:2009-07-02 09:58:17

标签: java eclipse javadoc

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

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

1 个答案:

答案 0 :(得分:7)

这被认为是一个好主意back in 2002,仍然是asked for in 2004 ...

但是从那时起,Sun Doc Check Doclet的几乎所有功能(最初为Sun内部使用而开发并发布给开发人员社区以供原样使用的实验代码)几乎涵盖了'{{{{ 1}}'Java项目属性的一部分(尽管没有HTML rapports输出)

如果您确实想要获得DocCheck报告,我建议您制作一个custom Project Builder,例如this one(与DocCheck完全无关,就在这里为您举例)

alt text
(来源:bell-labs.com

另请参阅 FAQ How do I implement an incremental project builder? FAQ How do I create an external tool builder?

我还建议您设置此自定义构建器,仅在执行填充构建(Java Compiler / Javadoc)时调用DocCheck,以避免每次保存文件时等待。

  

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