在导出jar文件时为Eclipse项目添加Java文档

Question

我在Eclipse中有一个Java项目可以生成一个Jar文件。现在我可以在其他项目中使用这个jar文件。但是，当我使用Eclipse将该jar文件添加到其他项目的构建路径时，它不会显示任何文档。

只有在生成Jar文件时，如果我还单独生成Java文档，并且在用户端导入此jar时，我必须单独指定此jar的Java文档才能正常工作。

我想知道是否有办法将Java文档和项目一起导出为单个Jar文件，以便在使用Eclipse IDE导入其他项目时，无需显式导入Java文档即可显示文档？

- Johnydep

Answer 1

如果在导出JAR文件时选择了"导出源文件和资源"选项，那么您应该能够在其他项目中看到文档。

- Manish

---

谢谢Manish，但如果我只想添加类文件而不是实际的.java文件，这种方式仍然可行吗？ - Johnydep

不，您必须同时包含源文件。 - Manish

好的，实际上如果我只导出文档，然后只导出带有类文件的项目，任何人都可以将这些文档导入到导出的jar中，并且在该jar中不包含.java文件时它可以正常工作，所以我想如果我想要一个单一的包，我也必须包括.java文件。 - Johnydep

是的，你说得对。Eclipse会在jar包中寻找与类相对应的源文件。如果它找到了源文件，就会从中读取javadoc，否则你需要提供该jar包的源代码压缩文件或javadoc压缩文件。 - Manish

Answer 2

@manish的方法对我不起作用。在我的情况下，解决方案是不同的。您也可以尝试以下四个简单步骤：

1. 右键单击项目 - 导出 - Jar文件
2. 右键单击项目 - 导出 - JavaDoc
3. 使用7Zip或类似软件压缩JavaDoc文件夹。将其重命名为“jar”扩展名。
4. 创建包含两个文件夹的文件夹并进行压缩。同样将其重命名为“jar”扩展名。

例如

/your-library-v1.0.0.jar
  - your-library.jar 
  - your-library-doc.jar

现在您可以导入库（your-library-v1.0.0.jar），并且Javadoc将在您的项目中可用。

- bishop