作为构建过程的一部分,是否需要生成javadoc?

作为构建过程的一部分,是否需要生成javadoc?,java,documentation,build-process,javadoc,Java,Documentation,Build Process,Javadoc,作为构建过程的一部分,有必要生成javadoc吗?不,没有必要生成javadoc好吧,没有什么真正迫使您这么做的,但是,如果您想将构建工件作为一个可用的库分发,那么拥有编写良好的javadoc肯定会有所帮助,人们可以在下载您的JAR之前浏览这些文档。否。您在构建过程中选择做什么取决于您(或客户)。默认情况下,某些构建系统可能包括JavaDoc生成,但禁用它应该很简单。您没有提到这是用于web应用程序的构建,还是用于分发的库。正如其他回复者所提到的,这并不是真正必要的,但对于内部维护的web应用程

作为构建过程的一部分,有必要生成javadoc吗?

不,没有必要生成javadoc

好吧,没有什么真正迫使您这么做的,但是,如果您想将构建工件作为一个可用的库分发,那么拥有编写良好的javadoc肯定会有所帮助,人们可以在下载您的JAR之前浏览这些文档。

否。您在构建过程中选择做什么取决于您(或客户)。默认情况下,某些构建系统可能包括JavaDoc生成,但禁用它应该很简单。

您没有提到这是用于web应用程序的构建,还是用于分发的库。正如其他回复者所提到的,这并不是真正必要的,但对于内部维护的web应用程序和外部分发的库来说,文档(javadoc的形式)将非常有用。

如果您的构建过程使用Ant,我会说这可能没有必要,但这样做应该不会很困难。您只需使用javadoc任务,生成它,并完成它。

一点也不需要

如果代码的大多数用户直接访问Java文件并使用IDE,那么他们可能已经在通过代码编辑器中的悬停来读取Javadoc了。这可能比签入或正在生成的版本更为最新(除非您有连续生成)

如果您向客户机公开临时版本(例如,您是一个开源项目),那么提供JavaDocs而不仅仅是类文件会进一步将您绑定到特定的语义。对API提供更严格的控制是有意义的,Javadoc本质上描述了API

如果您不希望任何外部用户使用您的公共接口(例如,您让它们对将来的插件开放),您不能阻止它,但您当然可以通过提供JavaDocs来避免鼓励它。

您可以决定是否有必要这样做。就个人而言,我不会在每次构建时生成javadoc和其他繁重的报告(生成这些报告有点贵),我希望让构建在开发人员机器上运行,并通过持续集成引擎尽快运行(尽管持续集成引擎构建并发布源JAR)。报告生成在夜间构建期间完成

作为构建过程的一部分,是否需要生成javadoc