Eclipse產生javadoc協助文檔及基礎知識

前言：

1.產生的API文檔是一個名為index.html的檔案

2.javadoc只處理文檔源檔案在類，介面，方法，成員變數，構造器，內部類之前的注釋，忽略掉其他地方的注釋

3.javadoc工具預設只處理以public或protected修飾的類，介面，方法，成員變數，構造器，內部類前的文檔注釋

4.文檔注釋以兩個型號（/**）開始，以星號後緊跟一個斜線(*/)結束，中間部分都是文檔注釋，會被提取到API文檔中

5.常用javadoc標記：

@author：指定Java程式的作者

@version：指定源檔案的版本

@deprecated：不推薦使用的方法

@param：方法的參數說明資訊

@return：方法的傳回值說明資訊

@see：“參見”，用於指定交叉參考的內容

@exception：拋出異常的類型

@throws：拋出的異常，和@exception同義

用Eclipse產生javadoc文檔：

1.開啟java代碼，編寫JavaDoc 注釋（盡量寫的詳細）

2.點擊eclipse的【Project】菜單，選擇【Generate JavaDoc】選項

3.

（1）選擇要產生JavaDoc的工程

（2）選擇哪些層級的內容產生JavaDoc，預設為public，如果選擇private則會全部內容都產生。

（3）選擇doc的產生位置，預設為工程目錄下，建議不要修改。

（5）點擊【Next】按鈕

4

（1）勾選Document Title，然後填寫文檔標題。

（2）點擊【Next】按鈕

5.

（1）選擇使用的jdk版本

（2）點擊【Finish】按鈕
6.項目下產生一個【doc】的目錄，裡面存放著javadoc文檔