api文档生成

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

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

以下面这个项目为例

右键

看图吧

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

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

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

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


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

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

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

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


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

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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 原文地址:RESTful web API文档生成器 问:开发业务模块代码最重要的是什么?答:API接口文档 如果你...
    brucewar阅读 4,911评论 0 51
  • 标签(空格分隔): node.js apidoc可以根据代码注释生成web api文档,支持大部分主流语言java...
    xun阅读 112,881评论 23 40
  • 最近一直在整理公司前辈写的php后台api模块。发现api整理起来还是很麻烦的,而且很不直观,为此跟app端的开发...
    成木2016阅读 7,394评论 5 8
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,853评论 18 139
  • 自从上周日晚上,孩子经历了病毒感染,发烧三天,咳嗽四天至今还没有完全痊愈的历程,在一周六天内带孩儿去了四趟医院后,...
    荷中仙子阅读 185评论 1 1