api文档生成

网上有很多教程,不难,我肯定没有他们懂,所做的不过是把繁琐的说明说简单,简要话。

先下个工具http://url.cn/PSy9dk

以下面这个项目为例

api文档生成_第1张图片

右键

api文档生成_第2张图片

看图吧

api文档生成_第3张图片

这里选择java下面的生存javadoc,这个javadoc很多人都用过,就是和网页差不多

api文档生成_第4张图片

上面是选择安装java的javadoc编译器的位置,很容易找到,套用地址找就是 了。

下面是生成后的文件夹地址

api文档生成_第5张图片

这就生成后以网页形式的api文档,大家都用过。一样的

api文档生成_第6张图片

打开后还能看吧,像那么回事,注释写得少,写好点,就更像了。

继续往下看,我们来生成chm格式,都用过。

api文档生成_第7张图片

第一行:刚才生成api文档的地址,复制进去就是了,第二行,取个名字。后面就全是 y。

api文档生成_第8张图片

如箭头,生成结果。直接打开。

api文档生成_第9张图片

很丑,我没有写太多注释,生成api文档,一定要有标准的,丰富的注释,不然也是没啥用的。

这是个引子,还有很多注意的地方,比如说编码格式啊什么的。大家勇于拓展。

分享个链接http://www.csdn.net/article/2013-02-20/2814189-API_DOC_TOOLS

里面也只是介绍了有哪些工具,带各位大虾有兴趣的深究。

你可能感兴趣的:(api文档生成)