使用 3rd 方 Javadoc 做什么

Question

想看看其他人如何处理第 3 方（供应商）java 文档？它们是否受到源代码控制，以便每个人都可以访问它们？放在本地共享目录上？人们必须运作良好的其他解决方案。

我们使用clearcase，并让开发商和几个离岸集团遍布美国各地。

Answer 1

如果你有某种内部/外部网，我建议在一个地方收集所有内部/外部网。如果您不打算修改它们，我认为将它们置于版本控制之下没有任何好处。

Answer 2

我将它们添加到源代码管理中。

我有

• lib/ 用于第 3 方 jar 文件
• lib-doc/ 用于第 3 方 javadocs
• lib-src/ 用于第三方源

当我可能需要查找我使用的特定版本的 api 的源代码或文档时，我发现这对于将来的参考很有帮助。可能在 6 个月或 12 个月后，我使用的版本就不再公开可用。

Answer 3

我们使用 Trac

凭借其Bugtracker及其Wiki，您可以轻松管理项目所需的文档。此外，您还有许多适用于该工具的有用插件。我们不会将这种类型的文档放在我们的版本控制中，因为它会使我们的项目在一段时间后变大。

Answer 4

当您使用“文档”这个词时，我想您正在谈论 javadoc？

使用 Maven 的项目会处理这些事情。

对于其他项目，可以 共享外部 javadoc:

• 可在 网络 （只需配置您的环境即可显示它们）：这很容易设置，很容易占用资源，但有时可能会很慢（或变慢）......
• 可在 通用文件系统 ：这并不总是可能或不切实际的（想想你的离岸集团）
• 在源代码管理中提交（可能在不同的地方，以便常见的同步任务不必检查它们）：容易也；某些配置中可能存在性能问题