Java：API文檔；文檔注釋中的javadoc标記；官方API；自己動手給項目建一個API文檔

1、什麼是API文檔

在Java語言中有3種注釋

//單行注釋
/*
   多行注釋
 */
/**
 * 文檔注釋
 */           

API（應用程式接口）文檔就是用javadoc指令提取文檔注釋生成的，html格式，用浏覽器檢視。

API文檔既然是由文檔注釋生成的，那麼文檔注釋怎麼寫呢？

首先，文檔注釋必須放在類和方法的前面，格式也要準确。

其中，要寫清楚類和方法的功能，以及方法傳入的形參和傳回值具體是什麼。

一般來說，隻預設提取public和protected修飾的類、接口、方法、成員變量、構造器、内部類的說明。因為API文檔是提供給使用者看的，隻需要說明如何使用就好了。

2、文檔注釋中的javadoc标記

|@author|程式作者|類/接口的文檔注釋中|

|--|--|--|

|@version|程式版本|類/接口的文檔注釋中|

|@param|方法參數說明|方法/構造器的文檔注釋中|

|@return|方法傳回值說明|方法/構造器的文檔注釋中|

|@exception、@throws|抛出的異常|方法/構造器的文檔注釋中|

3、官網下載下傳

打開index.html：

4、自己建立一個API文檔

javadoc -d apidoc -windowtitle 測試 -doctitle JavaSE學習 -header 側欄名字 -author basicGrammar/*.java designPatterns/*.java           

• -d ：輸出檔案的目标目錄
• -windowtitle ：文檔的浏覽器視窗标題
• -doctitle ：概覽頁面的标題
• -header ：每個頁面的頁眉文本

  

• -author：包含 @author 段
• -version：包含 @version 段