任何将javadoc嵌入jar的方法

时间:2011-05-05 00:45:55

标签: java android javadoc

有没有办法将javadoc(由JavaDoc Ant Task生成的/ doc文件夹)嵌入到包含我的.class文件的库jar中?

我不想发送源代码,并且希望用户能够在eclipse中看到javadoc注释,而无需通过Referenced Libraries选项卡并将JavaDoc zip添加到我的第三方库。

2 个答案:

答案 0 :(得分:3)

当然你可以把javadoc放到你的二进制JAR文件中......但它真的有意义吗?

为了读取javadoc,用户必须将HTML文件从JAR文件解压缩到Android的文件系统中,然后将Android浏览器指向index.html文件(或其他)。但是使用JAR文件来运行代码的最佳模型不是解压缩它。如果你不希望你的用户试图在他们的手机上查看javadoc(!?!)...那么将javadocs放入JAR文件就是“自重”。

将javadoc树分布在单独的zip或tar文件中更有意义。

最后,如果您希望用户针对您产品中的API开发代码,那么如果您为他们提供源代码,则会更容易。您将获得更好的客户满意度,更少的支持请求来帮助他们调试代码,以及减少对您的代码无效的不合理投诉。

答案 1 :(得分:1)

当然你可以update这样一个jar文件。

jar uf <your_jar> doc/<your doc file>