Android Studio 导出JavaDoc文档

前言

在Java中，可以使用Javadoc工具来生成API文档。在源代码中使用Javadoc注释对类、方法、字段等进行描述和说明。Javadoc注释使用/** ... */的格式

步骤如下

一、Android Studio界面->Tools->Generate JavaDoc

二、弹出的对话框如下

Generate JavaDoc

1. 选择你要生成JavaDoc的范围
2. 选择导出的文件目录
3. 选择导出方法级别。默认为protected（含public和protected的方法和变量），如果想导出的api含有private方法和变量，请选择private
4. 填写zh-CN,导出的语言为中文，不填写，默认为英文
5. 填写编码格式为-encoding UTF-8 -charset UTF-8
6. 最后点击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'))
}