Myeclipse文件註釋如何提煉(匯出)成自己的API幫助文件?
阿新 • • 發佈:2019-01-25
第一步:
原始碼註釋規範,一定要用/** 兩個*這一特殊的註釋。註釋上可以新增@author等特殊說明,下圖是部分 javadoc 標記 資訊,可以根據需要選用。
第二步:
確保整個工程的專案都添加了特殊註釋後,右鍵工程,選擇export匯出。
第三步:
選擇java—>javadoc,然後點選next(下一步)。
第四步:
這個選項可以選擇javadoc命令,要生成api的工程以及API存放的路徑。javadoc command會自動選擇安裝的jdk的bin目錄下的javadoc應用程式,如果沒有自動選擇,點選configure選擇。
第五步:
選擇完後點擊next(下一步),可選擇jar包,編輯標題,樣式等,這裡選擇預設。
第六步:
點選next(下一步),根據需要填寫VM options資訊。
第七步:
最後點選”finish",選擇”yes to all“開始生成java API文件資訊。
第八步:
生成後到剛剛儲存的目錄下,找到index.html開啟文件檢視資訊。