是否有必要生成javadoc作为构建过程的一部分？

Question

是否有必要在构建过程中生成javadoc？

Answer 1

没有什么能真正迫使你去做，但是如果你想把你的构建工件分发为一个可用的库，那么人们在下载你的JAR之前可以浏览的编写好的Javadoc肯定会有所帮助。

Answer 2

没有。您在构建过程中选择的操作取决于您（或客户）。默认情况下，某些构建系统可能包含JavaDoc生成，但禁用它应该很简单。

Answer 3

不是没有必要

Answer 4

您没有提及这是一个构建，例如，一个Web应用程序，还是一个用于分发的库。正如其他回复者所提到的，它并非真正必要，但对于内部维护的Web应用程序和外部分布式库，文档（以javadoc的形式）将非常有用。

Answer 5

完全没有。

如果您的代码的大多数用户直接访问Java文件并使用IDE，那么他们可能已经通过代码编辑器中的悬停读取他们的JavaDocs。这可能比签入的版本或正在构建的版本更新（除非您有连续版本）。

如果您向客户端公开临时版本（例如，您是一个开源项目），那么提供JavaDocs而不仅仅是类文件会进一步将您绑定到特定的语义。有必要对您的API提供更严格的控制，并且您的JavaDocs本质上描述了您的API。

如果您不希望任何外部人员使用您的公共接口（例如，您将它们保留在未来的插件中），则无法阻止它，但您当然可以通过提供JavaDoc来避免鼓励它。

Answer 6

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

Answer 7

您决定是否有必要。就个人而言，我不会生成javadoc和其他繁重的报告（生成起来有点贵）在每个版本，我想保持构建运行在开发人员机器上和持续集成引擎尽快（虽然持续集成引擎构建并发布源jar）。报告生成在每晚构建期间完成。

Answer 8

  

是否有必要在构建过程中生成javadoc？

否