最近一直在做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去。。。
参考博文: