如何将JavaDoc DocCheck设置为Eclipse插件？ [英] How does one set up JavaDoc DocCheck as an Eclipse plugin?

问题描述

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

是否可以通过某种方式将DocCheck设置为eclipse插件？

解决方案

这被认为是一个好主意

_{（来源： bell-labs.com ）}

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

我也建议您设置仅在执行填充构建（ IncrementalProjectBuilder.FULL_BUILD ）时调用此DocCheck的自定义构建器，以避免每次保存文件时都要等待。

最终用户可以通过在导航器中选择一个项目，选择属性，然后转到 Builders页面，来添加外部工具构建器。 br>
在构建选项选项卡上，您可以指定构建器应在自动构建，手动构建还是在 Clean 上运行。

在大多数情况下，应在外部运行自动构建过程中的工具构建者破坏性太大，因为它们运行时间太长。

I have recently started using DocCheck for checking the validity of JavaDoc's in code files.

Is there some way to set DocCheck up as an eclipse plugin?

解决方案

This was deemed a great idea back in 2002, and still asked for in 2004...

But since then, pretty much all the features of the Sun Doc Check Doclet (experimental code developed originally for internal use at Sun and released to the developer community for use as-is) is pretty much covered by the 'Java Compiler / Javadoc' section of the Java project properties (albeit without the HTML rapports outputs)

If you do want to have the DocCheck reports, I would recommend making a custom Project Builder, like this one (not related to DocCheck at all, just here to give you an example)

_{(source: bell-labs.com)}

See also FAQ How do I implement an incremental project builder? or FAQ How do I create an external tool builder?

I would also recommend you set up this custom builder calling DocCheck only when doing a fill build (IncrementalProjectBuilder.FULL_BUILD), in order to avoid to wait each time you save a file.

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.

这篇关于如何将JavaDoc DocCheck设置为Eclipse插件？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！