如何为图书馆分发Javadoc？ [英] How should one distribute the Javadoc for a Library?

问题描述

我正在编写一个自定义库。它构建成.jar存档。我完全能够生成javadoc，但我不知道应该如何分发它？

I am writing a custom library. It's build into a .jar archive. I am fully able to generate the javadoc, but I don't know how I should distribute it?

1. 将它放在同一个.jar中与图书馆


2. 将它放在另一个.jar


3. 其他方式？

如何将javadoc包含在另一个使用我的lib的项目中？

And how to include the javadoc in another project that uses my lib?

1. 如果我放了它在同一个.jar中，我应该在清单中写一些东西吗？


2. 如果它在一个单独的.jar中，它是否足够包含在项目中？

我正在使用NetBeans 9.1。

I am using NetBeans 9.1.

推荐答案

我将包括库.jar以及文档和其他内容，如README，License文件等，在单个存档中（zip或tar.gz）

I'd include the library .jar and the documentation and other things, like a README, License file etc. in a single archive (zip or tar.gz)

mylib-1.0.1 .tar.gz，其中包含：

mylib-1.0.1.tar.gz , which contains:

mylib-1.0.1/
           ├── javadoc
           │   └── index.html  (and all other javadoc files under here)
           ├── mylib-1.0.1.jar
           └── README

而不是在存档中扩展了javadoc / sub目录，你可以在mylib-1.0.1-javadoc.jar（或zip）中添加压缩的javadoc，这两个选项很常见。

Instead of the expanded javadoc/ sub directory within the archive, you could add the compressed javadoc in a mylib-1.0.1-javadoc.jar (or zip) , both options are common.

mylib-1.0.1/
           ├── mylib-1.0.1-javadoc.jar
           ├── mylib-1.0.1.jar
           └── README

这篇关于如何为图书馆分发Javadoc？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！