1、打開java代碼,編寫JavaDoc 注釋,只有按照java的規范編寫注釋,才能很好的生成API文檔,javadoc注釋與普通注釋的區別為多一個*(星號)。普通代碼注釋為/*XXX*/,而javadoc的注釋為/**XXX*/
2、javadoc注釋要盡量寫的詳細,這樣別人在沒有源碼的情況下才知道如何使用您的代碼。
3、點擊eclipse的【Project】菜單,選擇【Generate JavaDoc】選項。
4. (1)選擇您要生成JavaDoc的工程
(2)選擇哪些級別的內容生成JavaDoc,默認為public,如果選擇private則會全部內容都生成。
(3)選擇doc的生成位置,默認為工程目錄下,建議不要修改
(4)點擊【Next】按鈕
5.(1)勾選Document Title,然后填寫文檔標題。
(2)點擊【Next】按鈕
6、(1)選擇使用的JDK版本
(2)點擊【Finish】按鈕
7、可以看到控制台輸出生成javadoc的信息。
8、項目下生成一個【doc】的目錄,里面存放着javadoc文檔。
9、打開doc目錄,用瀏覽器打開index.html
10、可以看到一個完整的API文檔、javadoc就生成了。