Android - 使用AndroidStudio生成API文档
2017-06-07 15:02
363 查看
最近封装了一个库,为方便他人使用想要制作一个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即可生成文档。
相关文章推荐
- AndroidStudio使用javadoc生成API文档
- 使用eclipse 生成自己项目的API帮助文档
- Java(四)——Java的文档注释(使用javadoc工具生成API文档)
- Android如何使用API文档
- 使用源码生成CHM格式的API文档
- 使用jsdoc-toolkit来自动生成js api文档
- 使用jsdoc-toolkit来自动生成js api文档
- showdoc使用笔记(自动生成api文档和数据库字典)
- ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
- 百度地图和高德地图坐标系的互相转换 四种Sandcastle方法生成c#.net帮助类帮助文档 文档API生成神器SandCastle使用心得 ASP.NET Core
- springmvc使用swagger生成rest api文档
- 将Android项目打包成jar与生成对应的api帮助文档(也就是注解)
- 使用Wisdom RESTClient自动化测试RESTful API和生成REST API文档
- Spring MVC中使用Swagger生成API文档和完整项目示例Demo,swagger-server-api
- 浅析如何在Nancy中使用Swagger生成API文档
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- Ubuntu12.04下使用doxygen生成API文档
- Android使用模板生成Word文档并查看
- 使用appledoc 生成技术API文档详解
- 工具:使用过的 API 文档生成工具