Android Studio 生成编写的SDK的API文档

2018.07.10 初稿

0. 引言

1. 介绍利用AS生成SDK相关API的文档。

1. 简介

• 利用AS生成SDK之后，还需要生成SDK的文档，也就是SDK的API的简介，手动是不可能手动生成的，只能利用IDE生成，AS就具有这个功能；
• 生成之后会产生一堆本地的文件，最好先定义一个存放API说明文档的文件夹；
• 具体的文档会存放在生成之前的包名下，选则那个com下的文件夹就对了；
• 生成的API文档依赖方法的doc注释，也就是你方法的javadoc写的是什么，就生成什么。

2. 步骤

1. 步骤一：点击菜单栏中的“Tools”，选择“Generate JavaDoc…”。
   

2. 步骤二：这时会弹出“Specify Generate JavaDoc Scope”对话框：
   

   • 图中①可以选择是否将项目中的所有文件都生成doc。
   • 图中②设置生成的doc文件保存到哪里。
   • 图中③用来配置一些属性。
   • 如果使用AS生成doc文档时报错：空指针异常，就会用到这里了。我们只需要在这里通过-bootclasspath命令指定android.jar的路径就行了。如：-bootclasspath D:/Develop/sdk/platforms/android-23/android.jar（注意命令和路径之间需要用空格断开）。
   • 如果使用AS生成doc文档时出现日志信息乱码，也会用到这里。这说明在创建工程时使用的文件编码为UTF-8，我们只需要在原有内容之后追加 -encoding utf-8 -charset utf-8 命令即可。
   • 图中④可以选择是否在生成doc成功后是否在浏览器中显示。

3. 总结

• 图中1可以对module中的单个文件生成Javadoc文档，对不希望全部生成的，可以单独生成文档。

4. 参考文献

1. AndroidStudio使用javadoc生成API文档