1. 程式人生 > >使用eclipse生成javadoc檔案

使用eclipse生成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 中文”,但是生成的有一些網頁是亂碼,似乎解決不了。