前言
在Java中，可以使用Javadoc工具來生成API文檔。在源代碼中使用Javadoc注釋對(duì)類妻怎、方法刁赖、字段等進(jìn)行描述和說明搁痛。Javadoc注釋使用/** ... */的格式
步驟如下
一、Android Studio界面->Tools->Generate JavaDoc
二乾闰、彈出的對(duì)話框如下
Generate JavaDoc
- 選擇你要生成JavaDoc的范圍
- 選擇導(dǎo)出的文件目錄
- 選擇導(dǎo)出方法級(jí)別落追。
默認(rèn)為protected（含public和protected的方法和變量），如果想導(dǎo)出的api含有private方法和變量涯肩，請(qǐng)選擇private- 填寫
zh-CN,導(dǎo)出的語(yǔ)言為中文轿钠，不填寫，默認(rèn)為英文- 填寫編碼格式為
-encoding UTF-8 -charset UTF-8- 最后點(diǎn)擊
Generate按鈕開始導(dǎo)出
三病苗、導(dǎo)出常見錯(cuò)誤及解決方案
android方法報(bào)錯(cuò)
我們的代碼中會(huì)含有android相關(guān)的方法疗垛，導(dǎo)出時(shí)，控制臺(tái)會(huì)報(bào)錯(cuò)硫朦，例子如下
程序包android.content不存在
解決方案
錯(cuò)誤原因：由于在運(yùn)行Javadoc時(shí)未包含Android SDK目錄導(dǎo)致的贷腕。Android中的許多類都位于android.*包中母怜，因此如果Javadoc無法找到該包尘应，將會(huì)導(dǎo)致生成HTML文檔時(shí)出現(xiàn)錯(cuò)誤。為了解決這個(gè)問題增拥，可以按以下步驟進(jìn)行處理：
1破婆、確保已正確安裝Android SDK：請(qǐng)確保您已正確安裝了Android SDK涮总。
2、打開Android SDK安裝目錄祷舀，進(jìn)入 安裝目錄/platforms/android-32/android.jar ,這邊的32是你代碼使用的安卓版本號(hào)瀑梗，請(qǐng)根據(jù)自己實(shí)際情況獲得烹笔。
3、拷貝android.jar到項(xiàng)目的libs目錄下抛丽。
4谤职、在module下的build.gredle->dependencies中添加以下代碼
dependencies {
...
implementation(fileTree('libs'))
}
