美文网首页
api文档生成

api文档生成

作者: 天空下天的月亮 | 来源:发表于2016-12-09 10:17 被阅读0次

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

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

以下面这个项目为例

右键

看图吧

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

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

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

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

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

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


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

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

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

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

相关文章

网友评论

      本文标题:api文档生成

      本文链接:https://www.haomeiwen.com/subject/ewjemttx.html