2011-05-05 25 views
6

有沒有辦法將javadoc(由JavaDoc Ant Task生成的/ doc文件夾)嵌入到包含我的.class文件的庫jar中?任何將javadoc嵌入jar的方法

我不希望發佈源代碼,並希望用戶能夠在eclipse中查看javadoc註釋,而不必通過引用庫選項卡並將JavaDoc zip添加到我的第三方庫。

回答

1

當然你可以用update這樣的jar文件。

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

3

當然,你可以把javadoc的到您的二進制JAR文件...但它真的有意義嗎?

爲了閱讀javadocs,用戶需要將JAR文件中的HTML文件解壓縮到Android的文件系統中,然後將Android瀏覽器指向index.html文件(或其他)。但使用JAR文件運行代碼的最佳模式不是解壓縮它。如果您不希望用戶嘗試在手機上查看javadoc(!?!),那麼將javadoc添加到JAR文件中就是「重量級」。

將javadoc樹分佈在單獨的zip或tar文件中更有意義。最後,如果您希望用戶針對產品中的API開發代碼,那麼如果您向他們提供源代碼,它們將變得更加容易。您將獲得更好的客戶滿意度,減少幫助他們調試代碼的支持請求,並減少有關您的代碼無法正常工作的不合理投訴。

+0

我不希望他們從手機中查看javadoc,而是希望他們將它用作API。我希望我可以分發源代碼,但我無法出於許可證原因。 我希望我的圖書館能夠像谷歌如何運送Android一樣。我能夠看到Android API文檔,但android.jar只包含類。 – AndroidPlaya 2011-05-05 02:35:16

+0

*「我可以看到Android API文檔,但android.jar只包含類。」*正確!谷歌不要把javadocs放到二進制JAR中......而你也不應該這樣做。 – 2011-05-05 06:28:40

相關問題