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會自動顯示其注釋說明,可以大大提高開發人員的效率。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM