摘要：通過Java doc工具為專案程式原始碼中抽取類、方法、成員等註釋形成一個和原始碼配套的API幫助文件。只要在編寫程式時以一套特定的標籤作註釋，在程式編寫完成後，通過Javadoc就可以同時形成程式的開發文件。介紹Eclipse及Android Studio中生成專案API開發文件，幫助學習上手專案。

Java Doc

概述

百度百科：javadoc是Sun公司提供的一個技術，它從程式原始碼中抽取類、方法、成員等註釋形成一個和原始碼配套的API幫助文件。也就是說，只要在編寫程式時以一套特定的標籤作註釋，在程式編寫完成後，通過Javadoc就可以同時形成程式的開發文件了。
javadoc命令是用來生成自己API文件的，使用方式：在dos中在目標檔案所在目錄輸入javadoc +檔名.java。

常用標記

註釋規範

註釋

// 註釋一行
/* …… */ 註釋若干行
/* …… / 註釋若干行，並寫入 javadoc 文件

註釋格式

可嵌入HTML標籤
回車：< br >
分段： < p >

例如：
/**
* show 方法的簡述.
*

show 方法的詳細說明第一行

* show 方法的詳細說明第二行
* @param b true 表示顯示，false 表示隱藏
* @return 沒有返回值
*/
public void show(boolean b) {
frame.show(b);
}

第一部分是簡述。文件中，對於屬性和方法都是先有一個列表，然後才在後面一個一個的詳細的說明
簡述部分寫在一段文件註釋的最前面，第一個點號 (.) 之前 (包括點號)。換句話說，就是用第一個點號分隔文件註釋，之前是簡述，之後是第二部分和第三部分。

第二部分是詳細說明部分。該部分對屬性或者方法進行詳細的說明，在格式上沒有什麼特殊的要求，可以包含若干個點號。
* show 方法的簡述.
* < p >show 方法的詳細說明第一行< br >
* show 方法的詳細說明第二行

簡述也在其中。這一點要記住了

第三部分是特殊說明部分。這部分包括版本說明、引數說明、返回值說明等。
* @param b true 表示顯示，false 表示隱藏
* @return 沒有返回值

Eclipse

1. Project——>Generate Javadoc

   

2. 選擇專案

   

3. 設定文件名稱等

   

4. 設定編譯選項

   

Android Studio

1. Tools——>Generate JavaDoc…

   

2. 選擇輸出的範圍等

   

參考