1. 程式人生 > >eclipse如何為java專案生成API文件、JavaDoc

eclipse如何為java專案生成API文件、JavaDoc

1.開啟java程式碼,編寫JavaDoc 註釋,只有按照java的規範編寫註釋,才能很好的生成API文件,javadoc註釋與普通註釋的區別為多一個*(星號)。普通程式碼註釋為/*XXX*/,而javadoc的註釋為/**XXX*/

Screenshot-2.png

2.新增完註釋之後,如下選擇生成API文件

Screenshot-0.png

3.填寫選項

    a.選擇執行的javadoc.exe,

    b.選擇要生成API文件的java檔案,

    c.選擇在那些型別的方法可以引數生成API文件,

    d.選擇文件的輸出位置

Screenshot-4.png

4.填寫文件名稱

Screenshot-6.png

5.這裡要指定編碼進行編譯生成API文件(非常重要!,不填會產生編碼錯誤問題),選擇jre的版本,點選finish,就可以了

Screenshot-7.png

6.效果圖

Screenshot-8.png

Screenshot-9.png