使用jar文件打包參考文檔

我們正在將我們的.NET庫移植到java等價物上，現在正在研究如何分發此端口。將這些類打包成一個jar文件看起來是最好的做法，然後我們會將這個jar文件與一些許可證條款一起放入一個zip文件中。使用jar文件打包參考文檔

但是文檔呢？在.NET領域，似乎最好的做法是分發可由工具（Visual Studio）使用的xml文件，但我們似乎無法找到針對java的此類最佳實踐。我們對我們的公共類和接口有javadoc評論，所以我們只是尋找一種方式來生成和發佈這些評論的方式，這對開發者來說很友好（我們認爲這些評論很容易從各種IDE中使用）。開發人員期待什麼以及您如何最好地實現這一目標？

我們真的喜歡與JAR文件一起打包的文件，而不是必須承載在我們網站上的文檔

編輯：我們想爲我們的文檔到Java的IDE裏面出現，所以我們要提供儘可能優雅地將文檔集成到IDE中。在.NET領域，這是一個放在.dll文件旁邊的xml文件，但是對於jar文件來說，是否存在類似的概念，從而能夠集成到工具中？ PS：我們正在Eclipse中開發，並且在我們的自動構建中有一個ant任務來完成構建和jar文件打包。

來源

2010-04-19 soren.enemaerke

常用的方法是創建一個'doc'文件夾，在該文件夾下爲您的項目生成JavaDoc。然後

你的最終方案是這樣的：

finalpackage.zip：

product.jar
DOC
許可
其他的東西

Maven品牌這很簡單，但是像Ant這樣的工具也可以很容易地設置來做到這一點。顯然，也有手動方式，但建議將其作爲構建過程的一部分。

來源

2010-04-19 12:32:54

一個問題：我來自.NET，但面對它似乎應該有一個更加中立和消耗的格式（如XML）的IDE，因此每個IDE不必實現自己的解析引擎forforfor文檔文件（我認爲是由javadoc輸出的html文件） – 2010-04-19 12:36:47

JavaDoc不像eg沙塔。 JavaDoc html輸出是一個完整的隨時可用的網站，只需點擊'index.html'即可。在大多數Java IDE（Eclipse，Netbeans等）中，您可以爲類路徑中的每個jar指定一個JavaDoc文件夾。生成的html對於IDE來說相當容易處理，因爲JavaDoc爲每種類型生成1個html文件。因此，com.eric.MyFunkyType的文檔最終在com/eric /子文件夾中的MyFunkyType.html中。 – 2010-04-19 13:19:09

感謝Eric的回覆。在我看來，這需要額外的步驟來指定文檔的位置（而不是按照慣例通過Visual Studio發現它），但我瞭解如何扣除特定文件的位置。但實際成員信息等的解析必須取決於所選的html輸出格式，對不對？我可能在這裏狹隘，但xml似乎是保存工具信息的邏輯最低公共分母 – 2010-04-19 13:24:53

提供文檔的最常用方式是從Web創建一個javadoc網站，visibile。最明顯的方法是在你的項目上調用ajvadoc命令。這樣，完整的網站將被生成。但是，爲了讓它與您的代碼同步，我建議您採用完整的企業構建方式，併爲您的項目創建maven版本。這樣，在創建商業版本（mvn release命令）時，將創建一個完整的文檔網站，其中包含有關您項目的所有報告。

來源

2010-04-19 12:23:42 Riduidel

我認爲最常用的方法是爲您的庫提供javadoc和源代碼jar。使用maven，你可以執行mvn dependency:sources，IDE應該爲你的庫提供所有上下文相關的幫助。當然，應該可以通過網絡訪問javadoc。

來源

2010-04-19 12:36:58

使用jar文件打包參考文檔

回答

相關問題