1. 程式人生 > >Eclipse中給jar包匯入JavaDoc的方法

Eclipse中給jar包匯入JavaDoc的方法

  在使用Java語言開發的過程中,開發人員經常需要用到一些開源的工具包。在使用別人的jar包的時候,為了保證正常呼叫包內的方法需要把jar包新增到Referenced Libraries中。由於jar中通常只打包了類的二進位制檔案,其JavaDoc檔案仍需要以瀏覽器或chm幫助文件的方式檢視。Eclipse開發環境中提供了將JavaDoc文件附加到jar包中的功能,使開發者不再需要人工查詢類或方法的JavaDoc註釋,省時又省力。

  Eclipse支援兩種方式的JavaDoc匯入:一種是線上的URL地址指向的JavaDoc頁面,另一種是儲存在本地的JavaDoc文件的jar包或zip包。給jar包附加JavaDoc的步驟如下:

  1. 在Eclipse的Package Explorer檢視下Referenced Libraries下找到想匯入JavaDoc的jar檔案,右鍵->選擇properties進入屬性配置選單。
  2. 在屬性選單中點選JavaDoc Location選項卡進入JavaDoc地址配置功能。
  3. 根據能獲得的JavaDoc文件的具體情況,選擇JavaDoc URL或JavaDoc in Archive中的任一個分別設定相應的JavaDoc地址。如果選擇以JavaDoc URL方式匯入,則在javadoc location path中填入JavaDoc的URL地址,如http://hc.apache.org/httpcomponents-client-4.0.1/httpclient/apidocs/
    (注意,不要在路徑中指定index.html);如果選擇以JavaDoc in Archive的方式匯入,則在javadoc location path中填入本地JavaDoc檔案的路徑(注意,在打包javadoc檔案裡要把index.html檔案放在資料夾的頂層目錄下。

在匯入了javadoc後,編寫程式的過程中使用jar包中的方法時Eclipse會自動顯示其註釋說明,可以大大提高開發人員的效率。