Android - 使用AndroidStudio生成API文档

最新推荐文章于 2022-11-28 00:05:28 发布

mythmayor

最新推荐文章于 2022-11-28 00:05:28 发布

阅读量4.6k

点赞数

分类专栏： Android 文章标签： android api 文档 AS生成API文档生成API文档

本文链接：https://blog.csdn.net/mythmayor/article/details/72899872

版权

Android 专栏收录该内容

102 篇文章 3 订阅

订阅专栏

转载请注明出处：https://blog.csdn.net/mythmayor/article/details/72899872

最近封装了一个库，为方便他人使用想要制作一个API文档，经过研究后现将制作过程记录如下，方便他人参考与自己使用。

1.既然是API文档，所以有些文字说明是很有必要的。我们需要在方法的上面说明一下方法的含义及作用，并且指出返回值和参数的意义。下面用两个方法来举例说明，注意，此时的注释的格式为多行注释

/**
 *
 */

而非单行注释//。

    /**
     * 初始化方法
     * @param username 用户名
     * @param password 密码
     */
    public void init(String username, String password) {
        this.username = username;
        this.password = password;
    }

    /**
     * 两个数相加的方法
     * @param number1 第一个数
     * @param number2 第二个数
     * @return 两个数相加的和
     */
    public int addition(int number1, int number2) {
        return number1 + number2;
    }

2.选中你想要生成的Module或者是依赖库Android Library，点击AndroidStudio顶部导航栏的Tools，并选择Generate JavaDoc…

这里写图片描述

3.如果你是选择的一个Module或者是依赖库Android Library，则会显示如下，此时你可以选择Whole project(整个项目)或者是你选中的这个Module。

如果你选择的是一个文件，则会有Current File等选项。另外你需要配置一下Output directory即生成文档的输出目录。

需要格外注意的是，在下方Other command line arguments的地方也需要配置一下，否则很容易会报错，我的配置是：

-bootclasspath D:/My_Development/Android/AndroidStudio/sdk/platforms/android-25/android.jar -encoding utf-8 -charset utf-8

很显然，这是一个命令行，你可以根据你的AndroidStudio目录和你的编码来进行配置。

对话框最后那行Open generated documentation in browser可以选择是否在生成doc成功后是否在浏览器中显示

完成这几步后点击OK即可生成文档。