1. 程式人生 > >你不知道的Eclipse用法:使用Javadoc匯出專案的API文件

你不知道的Eclipse用法:使用Javadoc匯出專案的API文件

    技術文件是專案的重要組成部分,Javadoc則是Java技術文件的基礎之一。Javadoc為Java程式碼生成一組便於使用的API文件,作為溝通工具,這些文件可提供有益的幫助,使團隊成員理解其他成員正在進行的工作。
    當然,要獲得良好的Javadoc文件,要求原始碼中有精心編寫的有意義的註釋,對任何工具而言,這都是苛刻的要求。這不是本文的重點內容。
本文將具體講述使用Eclipse開發工具匯出專案的Javadoc文件的步驟和常見的問題。
    Eclipse匯出文件操作步驟:
    根據Javadoc文件的說明標準,對專案中的類、介面等檔案精心編寫註釋。
    選中要生成javadoc的專案,右鍵->Export(匯出)。選擇Java->javadoc,點選Next>。
這裡寫圖片描述

分別選擇如下選項,點選Next。
javadoc command:設定javadoc命令的路徑。
select types for which javadoc will be generated:選擇需要生成的專案
Create javadoc for members with visibility:選擇生成文件的類和方法的訪問範圍。
Destination:選擇生成文件的目標目錄。
這裡寫圖片描述
在Documenet title中填入生成文件的名稱,其它選擇預設,點選Next。
這裡寫圖片描述
在VM options中填入-encoding utf-8 -charset utf-8,具體的編碼方式,根據你的專案
的編碼方式決定。點選Finish。
注意:如果編碼方式不對,會出現編碼錯誤報錯!!!
這裡寫圖片描述

這裡寫圖片描述
    在生成文件的時候,出現GBK編碼無效的報錯時,是由於Java預設使用GBK編碼, 與你的專案衝突導致的,在匯出中文文件的時候這個問題尤為突出,在生成文件想到中,注意在VM options中填入-encoding utf-8 -charset utf-8。可以解決此問題。
    by: http://blog.csdn.net/p106786860/article/details/9175335#comments