java - 任何将 javadoc 嵌入 jar 的方法

标签 java android javadoc

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

我宁愿不发布源代码,并希望用户能够在 eclipse 中看到 javadoc 注释,而无需通过“引用库”选项卡并将 JavaDoc zip 添加到我的第三方库。

最佳答案

当然可以将 javadoc 放入二进制 JAR 文件中……但这真的有意义吗?

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

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

最后,如果您希望用户针对您产品中的 API 开发代码,那么如果您向他们提供源代码,对他们来说会容易得多。您将获得更高的客户满意度,减少帮助他们调试代码的支持请求,并且减少对您的代码无法正常工作的无理投诉。

关于java - 任何将 javadoc 嵌入 jar 的方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5891479/

相关文章:

JavaDoc方法签名缩进

java - 带有泛型的未知 Javadoc 标记 TYPE

java - 记录代码库中 EJB3 注释的使用情况

java - Spring Boot 基于角色的安全 JWT

android - MediaPlayer getDuration 返回 -1412558917

android - Google I/O 2010 - ListView 的世界 notifyDataSetChanged()

java - 关于activity和fragment之间通信的问题

java - 如何在没有 Quartz 的情况下安排任务

java - OpenNLP 模型构建器插件无法继续

java - 转储 keystore 内容 : Permission denied keytool java_cacerts