前言
在Java中，可以使用Javadoc工具來生成API文檔。在源代碼中使用Javadoc注釋對類、方法、字段等進行描述和說明。Javadoc注釋使用/** ... */的格式
步驟如下
一、Android Studio界面->Tools->Generate JavaDoc
二、彈出的對話框如下
Generate JavaDoc
- 選擇你要生成JavaDoc的范圍
- 選擇導出的文件目錄
- 選擇導出方法級別。
默認為protected（含public和protected的方法和變量），如果想導出的api含有private方法和變量，請選擇private- 填寫
zh-CN,導出的語言為中文，不填寫，默認為英文- 填寫編碼格式為
-encoding UTF-8 -charset UTF-8- 最后點擊
Generate按鈕開始導出
三、導出常見錯誤及解決方案
android方法報錯
我們的代碼中會含有android相關的方法，導出時，控制臺會報錯，例子如下
程序包android.content不存在
解決方案
錯誤原因：由于在運行Javadoc時未包含Android SDK目錄導致的。Android中的許多類都位于android.*包中，因此如果Javadoc無法找到該包，將會導致生成HTML文檔時出現錯誤。為了解決這個問題，可以按以下步驟進行處理：
1、確保已正確安裝Android SDK：請確保您已正確安裝了Android SDK。
2、打開Android SDK安裝目錄，進入 安裝目錄/platforms/android-32/android.jar ,這邊的32是你代碼使用的安卓版本號，請根據自己實際情況獲得。
3、拷貝android.jar到項目的libs目錄下。
4、在module下的build.gredle->dependencies中添加以下代碼
dependencies {
...
implementation(fileTree('libs'))
}
