在Eclipse中加入jar包的javadoc或者源代碼

動機：在使用Eclipse做程序的時候，如果有程序的源代碼，那麼在調用別人的方法的時候，會把方法的形參作爲默認的參數，如ConstanceAggregateFacade.getConstanceAggregate(constanceId)；但是，如果沒有的話，就會變成arg0，如ConstanceAggregateFacade.getConstanceAggregate(arg0)。雖然，這樣看似乎沒有多大的區別，但是有很多缺點：1、增加了程序員無謂的工作量；2、如果參數很多，而且類型相同的話，單純的arg0、arg1、arg2、arg3...增加了出錯的機率。因此，準備解決一下這個問題。這對Facade類尤爲重要。

1、使用javadoc。
1.1、生成javadoc。在Eclipse的Project菜單上，點Generate javadoc。一路next下去，注意在最後需要指定生成的編碼(-encoding UTF-8 -charset UTF-8)。會在指定的文件夾下生成一些html。
1.2、將javadoc打包。把生成的文件夾打包成ZIP文件。注意，index.html文件必須在包的最外層，不能有多餘的文件夾結構。
具體操作：到要打包的文件夾裏面，選擇所有的文件和文件夾，然後壓縮；而不是直接在父文件夾上壓縮。
1.3、將生成的javadoc指定到jar包上。在Package Explorer視圖中，選擇jar包。右鍵單擊Properties，在Properties中找到指定javadoc的頁。如果想指定到文件夾，則選用URL方式；如果想指定到ZIP包，則選擇用archive方式。
至此，我們已經可以使用這個jar包的javadoc了。具體有兩個用途，首先保證了調用方法的形參，其次可以在javadoc視圖中看到類、方法、屬性的javadoc。這裏已經可以圓滿的解決參數的形參問題了。
在使用的時候，還有非常棘手的亂碼問題，不光光是要設置project的編碼，還要設置workspace的編碼。具體做法是，首選項>>Workspace>>Text file encoding。
1.4、額外的，可以把javadoc打成chm。使用“powerCHM 中文”，但是生成的有一些網頁是亂碼，似乎解決不了。


2、使用源代碼。
javadoc就是源代碼中抽取出來的。因此，使用源代碼可以解決使用javadoc的所有問題。即參數的形參和查看javadoc。
只需要簡單的說明源代碼的打包。同javadoc的打包，不能有多餘的文件夾結構。包的頂層就是com、org等package。

至此，我們可以看到，在真正發佈一個開源項目項目的時候。要製作：jar包、lib包、源代碼、javadoc，如果需要的話，還要做上fat jar包。


轉自:http://blog.csdn.net/lihaifeng555/article/details/6887397