java如何写安卓接口文档_android、java制作sdk以及自动生成文档

最近一直在做android开发，昨天经理让我写个接口SDK做个接口文档，以便后面的开发。

这让我很焦灼，SDK怎么做？要是只有敲代码还好。可是那个接口文档！！！文档这东西最讨厌了，头都大了

后来查了下资料，JDK有个自带的Javadoc，可以根据代码中的注释自动生成文档。一下子世界变亮了有木有！！

文档可以自动生成，那生成文档我依据是什么？

查下资料发现，只要在类、变量、方法上加注释，就能自动生成文档了。这些注释有自己的规范，可以先看看下面这篇博文

文档的事情搞定了，接下来就是SDK了。还没开始制作就遇到一个问题：

我是要新建Android工程、还是Java工程？

考虑到我只要实现网络数据的请求，不需要提供任何界面，这里就选择了Java工程。

(需要提供界面的会遇到解决资源文件不能打包的问题，这里有篇博文需要的同学可以去看看

首先学会怎么将工程打包成一个jar包(记得学java的第一节课上过)

1、在Eclipse中右击需要打包的工程,选择export

2 在export中展开java,选择JAR file，点击next

3 选择需要导出的工程、导出路径以及jar包的名字，点击finish

这样就能在改路径下找到我们生成的jar包了

jar包搞定了，接下来就轮到文档了

根据文章开头的Javadoc语法编辑工程后，就可以生成文档了，步骤如下：

1 右击工程，选择export

2 在export中展开java 选择Javadoc，点击next

3 在接下来的页面中：

Javadoc command 中选择jdk安装路径下的javadoc.exe

Select types for which Javadoc will begenerated 选择生成doc的工程

User standard doclet 选择doc的路径

点击next

4 使用默认设置，点击next

5 点击finish，就能在对应的目录下找到生成的doc

打开对应的文件夹能看到

打开 index，就能在浏览器中看到刚刚生成的文档了

是不是很眼熟！！！

似曾相识。。。

跟api文档好像

在生成文档的时候可能会看到这样的提示

“错误编码 GBK 的不可映射字符”

说明注释中有中文。解决方法：在生成文档的最后一步Vm options中输入 -encodingutf-8 -charset utf-8 就可以了

就这样搞定了。

知道做法以后生活是不是一下子就美好了！！！

乖乖做SDK去。。。

参考博文：

java如何写安卓接口文档_android、java制作sdk以及自动生成文档相关推荐

java动态生成sdk_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...
gin 生成api文档_golang gin框架集成swagger 自动生成文档
goswagger github仓库html https://github.com/swaggo/swag 安装 swag cligit 1.由于网络缘由,先安装gopm 管理工具github go ...
java接口废弃注释_Spring Boot如何让Web API自动生成文档，并解决swagger-annotations的API注解description属性废弃的问题...
前后端分离的系统架构中,前端开发人员需要查看后端WEB API的文档来进行开发.采用后端API文档自动生成的方式,可以大幅提高开发效率.swagger是一个被广泛使用的文档自动生成工具,可以与多种编程 ...
Java使用smart-doc自动生成文档
作为后端开发,写接口文档一直是一个很头痛的问题,今天推荐一个开源工具smart-doc,这个工具基于java原生的注释生成api文档,无需大量的注解配合使用. 官方地址:https://gitee.c ...
spring boot rest接口自动生成文档（包含swagger）
spring boot rest接口自动生成文档(包含swagger) 写接口免不了写接口文档,但是当文档与代码分开独立演进的时候,会发生很多不同步的问题. 接口描述与代码同 ...
spring boot rest接口自动生成文档（包含swagger）--gradle 下的配置
之前写过一篇文章:spring boot rest接口自动生成文档(包含swagger),这个使用的是maven作为依赖管理工具,现在,让我们体验一下gradle在spring boot项目中如何配置 ...
java前端目录_[Java教程]前端那点事儿——Tocify自动生成文档目录
[Java教程]前端那点事儿--Tocify自动生成文档目录 0 2016-06-29 22:00:07 今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目 ...
Matlab联合wps的API生成文档,让API自动生成文档
原标题:让API自动生成文档程序员最苦恼的事情莫过于写文档.由于业务口径频繁变更,因此很多接口也会频繁变更,频繁变更导致文档的维护是一件相当费时的事情,当优先级更高的事情袭来,更新文档反到成了次要工 ...
Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...

java如何写安卓接口文档_android、java制作sdk以及自动生成文档

java如何写安卓接口文档_android、java制作sdk以及自动生成文档相关推荐

最新文章

热门文章