1、什么是API文檔
在Java語言中有3種注釋
//單行注釋
/*
多行注釋
*/
/**
* 文檔注釋
*/
API（應用程序接口）文檔就是用javadoc命令提取文檔注釋生成的，html格式，用瀏覽器查看。
API文檔既然是由文檔注釋生成的，那么文檔注釋怎么寫呢？
首先，文檔注釋必須放在類和方法的前面，格式也要准確。
其中，要寫清楚類和方法的功能，以及方法傳入的形參和返回值具體是什么。
一般來說，只默認提取public和protected修飾的類、接口、方法、成員變量、構造器、內部類的說明。
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 段