有没有一种方法可以将 javadoc（JavaDoc Ant 任务生成的 /doc 文件夹）嵌入到包含 .class 文件的库 jar 中？
我希望不必提供源代码，用户能够在 Eclipse 中查看 javadoc 注释，而不必通过“引用库”选项卡并添加 JavaDoc 压缩文件来使用我的第三方库。
我希望不必提供源代码，用户能够在 Eclipse 中查看 javadoc 注释，而不必通过“引用库”选项卡并添加 JavaDoc 压缩文件来使用我的第三方库。
2个回答
3
当然，您可以将javadoc放入二进制JAR文件中...但这真的有意义吗？
为了阅读javadoc，用户需要将HTML文件从JAR文件解压缩到Android文件系统中，然后将Android浏览器指向index.html文件（或其他文件）。但是，使用JAR文件运行代码的最佳模型不是解压缩它。如果您不希望用户尝试在手机上查看javadoc（！？），则将javadoc放入JAR文件中是“多余的”。
更明智的做法是将javadoc树分发到单独的zip或tar文件中。
最后，如果您希望用户针对产品中的API开发代码，如果提供源代码，他们将会更容易。您将获得更好的客户满意度，减少支持请求以帮助他们调试其代码，并减少关于您的代码不起作用的不合理投诉。
为了阅读javadoc，用户需要将HTML文件从JAR文件解压缩到Android文件系统中，然后将Android浏览器指向index.html文件（或其他文件）。但是，使用JAR文件运行代码的最佳模型不是解压缩它。如果您不希望用户尝试在手机上查看javadoc（！？），则将javadoc放入JAR文件中是“多余的”。
更明智的做法是将javadoc树分发到单独的zip或tar文件中。
最后，如果您希望用户针对产品中的API开发代码，如果提供源代码，他们将会更容易。您将获得更好的客户满意度，减少支持请求以帮助他们调试其代码，并减少关于您的代码不起作用的不合理投诉。
- Stephen C
2
我不想让他们从手机内查看javadoc，我希望他们将其作为API在后者中使用。我希望我可以分发源代码，但由于许可证原因我无法这样做。我希望我的库能像谷歌发布Android一样。我可以查看Android API文档，但android.jar只包含类。 - AndroidPlaya
我能够看到Android API文档，但android.jar只包含类。确切地说，Google没有将javadocs放入二进制JAR文件中...而你也不应该这样做。 - Stephen C
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接