????Java 支持三種注釋方式。前兩種分別是?//?和?/* */，第三種被稱作說明注釋，以?/**?開始，以?*/結(jié)束。說明注釋允許在程序中嵌入關(guān)于程序的信息?？梢允褂?javadoc 工具軟件來生成信息，并輸出到HTML文件中，更加方便的記錄程序信息。
重點講解說明注釋，在開始的?/**?之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。之后，可以包含一個或多個各種各樣的?@?標簽。每一個?@?標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)，多個相同類型的標簽應(yīng)該放成一組。
下圖是javadoc可識別的標簽
javadoc 輸出
????javadoc 工具將 Java 程序的源代碼作為輸入，輸出一些包含程序注釋的HTML文件，每一個類的信息將在獨自的HTML文件里。
javadoc 也可以輸出繼承的樹形結(jié)構(gòu)和索引。
由于 javadoc 的實現(xiàn)不同，工作也可能不同，需要檢查你的 Java 開發(fā)系統(tǒng)的版本等細節(jié)，選擇合適的 Javadoc 版本。
配置默認說明注釋的模板：
在IDEA主界面點擊File，選擇setting進入到如下面板
第1步，選擇左邊欄的File and Code Templates；
第2步，選擇右邊欄的includes；
第3步，選擇File Header；
第4步，在右邊空白部分新建自己的說明注釋內(nèi)容；
最后，apply完成。
通過javadoc輸出說明注釋文件：
在IDEA主界面選擇Tools下的Generate JavaDoc
按照以上操作打開如下面板后
第1步，選擇需要生成 JavaDoc 的源代碼對象，一般以模塊（Module）為主，必要時可以單獨選擇必要的 Java 源代碼文件；
第2步，選擇輸出目錄；
第3步，將生成的 JavaDoc 設(shè)置為中文；
第4步，-encoding UTF-8 -charset UTF-8 -windowtitle "你的文檔在瀏覽器窗口標題欄顯示的內(nèi)容" -link?http://docs.Oracle.com/javase/7/docs/api
執(zhí)行生成javadoc文件之后，瀏覽器自動打開已輸出的注釋文檔
