说三道四技术文摘-感悟人生的经典句子
说三道四 > 文档快照

告别手写 API文档生成工具推荐

HTML文档下载 WORD文档下载 PDF文档下载
随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工欲善其事必先利其器,本文分享8款非常好的API文档生成工具给大家。

随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。

你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工欲善其事必先利其器,本文分享8款非常好的API文档生成工具给大家。


Web API文档工具列表

Swagger ——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在线 Demo 。

I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统。使用 JSON 模型根据资源、方法和参数定义 APIs。I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统。服务器端基于 Node.js 开发。在线Demo

apiary.io ——能够快速启动和运行文档,包括GitHub集成和I/O验证——更多建议可以前往Reddit查看上关于 Siyfion讨论。

Docco ——Docco是一个快速而随意、hundred-line-long、迭代程序风格的文档生成器。它会以HTML的方式显示评论和代码。

Dexy ——非常灵活的一款文档工具,支持任何语言编写的API。

Doxygen ——Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。 更多建议可以前往Reddi上查看 gkumar007相关讨论。

TurnAPI ——是一款付费的文档API工具。里面包含了智能WIKI编辑器、基于标准的Markdown、文档分支、还可以与Git、SVN、Mercurial同步、整洁的主题、友好的界面。

以上仅是作者在实践中发现的一些很好的工具,如果你有更好的建议或工具推荐,欢迎与我们分享。

来自:MATTSILVERMAN

height()-JQuery API width(val)-JQuery API width()-JQuery API DOM-JQuery API addClass(class)-JQuery API attr(key,fn)-JQuery API attr(key, value) -JQuery API attr(name)-JQuery API attr(properties) -JQuery API html(val)-JQuery API html()-JQuery API removeAttr(name)-JQuery API removeClass(class)-JQuery API text(val)-JQuery API text()-JQuery API toggleClass(class)-JQuery API val(val)-JQuery API val-JQuery API after(content) -JQuery API append(content) -JQuery API appendTo(expr) -JQuery API before(content)-JQuery API clone(deep) -JQuery API empty()-JQuery API insertAfter(expr)-JQuery API insertBefore(expr) -JQuery API prepend(content)-JQuery API prependTo(expr)-JQuery API remove(expr)-JQuery API wrap(elem)-JQuery API wrap(html) -JQuery API sqlserver 用 jdbc出错 ,Microsoft][SQLServer 2000 Driver for JDBC]Error setting up static cursor cache 如何在C#中用代码控制本地FTP服务打开和关闭?99分,中秋快乐. 关于dll的问题,在线求教 昨晚,我抱了我MM一下!开心呀!散分! 有什么软件可以使上网不受防火墙的限制? 一个C的图形函数,请问怎样用的? 数据库查询语句执行错误 web页面的activex控件怎么调用服务器上的动态连接库?? 中秋散分 【泰坦】祝大家中秋节快乐!(1) 纯jsp聊天室的页面刷新问题 这个MSDN是不是常说的那个MSDN资料库? 一句sql语句问题 【泰坦】祝大家中秋节快乐!(2) 我的触发器为什么没有响应啊。在线等啊 pb9.0+sql server 2000,怎样制作程序发布? pb给dll传递结构数组的问题。急!!! pb9.0+sql server 2000,怎样制作程序发布? 为什么关闭MSDEV的时候,会导致它占用90%以上的CPU时间??? 如何在代理中同時讓兩個套表同時結案 菜鸟问题:我想把一个CString类型转换成LPBYTE类型应该怎么弄? 如何在JRUN3.1中连接SQLSERVER, 我的web server用的是IIS5 怎么样在JSP中显示 WORD 或 WPS 格式的文件? 如何在servlet 中存储数组用javabean 取数组用JSP显示(在线等,急,谢谢) 如何使Response.Redirect "xxx.htm"打开的网页是满屏显示! 鄙视民工的人,给你讲个故事听。 庆祝中秋佳节,大散分~ 中秋节到了,与大家同庆,散点分!!!祝大家开心呀! VC的bug!!! 游戏、网络、图形等版块正在整顿中,有意见或建议欢迎提出!! 如何进一步提高C语言的功力???? 学习JSP的过程中遇到的问题(问题1),请进!!! 大家说一下网上下载的水晶报表crystal report 9.0会过期吗!!买一套要好几万的! 有个问题想请教,关于数码相机生成的图片的格式及存储方式! 在网站上数据保密问题 我用Inet控件下载文件时,经常会遇到无法结束程序的问题? 我在用电脑的时候,有时会提示我们插入WIN98光盘,但我现在用的这台,它会自动扫描的,自动查找,是怎么回事啊,在线等啊。 请问有DOS下的C++编译器吗???哪里下载?? 如何指定DataGrid的列宽呀 求boundschecker下载地址 怎么实现放大缩小的功能? 广州一妓女出租屋中被杀 被单缠身只穿一条内裤 关于setup Factory 和wise installer制作安装程序的问题 500分求解,解决问题结贴 新手入门求教 借中秋佳节,向ASP,JAVASCRIPT的网友们问好.. 请问如何用C实现把.hex文件转换成.bin文件呢? 数组存取 统计记录失败,各们大侠,请帮我看一下这个问题哈! 在当前目录下创建文件夹,并保存当前文件。。。 我的session为什么丢了? 恨安定爱变化的断句怎么断小猪《爱不单行》的歌词 你要回答就别抄别人的答案,你是不是上大学抄习惯了 怎么样为地球降温,请不要抄别人的答案! 哪里有严歌苓《幸福来敲门》(继母)的完整版啊?求分享 be是什么意思 英语啊 为什么我先回答的问题,别人抄了我的答案,你就把他纳为最佳答案 be在英语里表示什么意思 今天晚上给孩子检查作业,发现了炒答案,提前写在纸上,而且每次故意错2-3个,我的心都寒了,怎么一点都不懂事.我该怎么办?怎样和他讲道理呢?人与人最重要的信印一下子荡然无存. 写作业抄答案的辩论词(反方)反方的 小白拔得萝卜比小花多15个,这个数目正好相当于笑话吧的萝卜数的十分之三 小花拔了多少萝卜? 原来有几个萝卜?小白吃了5个,妈妈又拿来20个,现在有30个. 泰国沉船事故致一中国人遇难 渡轮超载武林CBD将启动推进11大项目 新增孙杨无驾照开豪车出车祸 致歉称将加强哪些中学的毕业生在清华成长性好 浙江宁波启动建设免费无线宽带 计划老三区浙江部分行政区划调整 绍兴撤县设区民金华市副市长张伟亚任政法委副书记叙利亚政府官员称外国武装分子传播小儿韩媒抱怨中国雾霾为“人类历史上最严重英国一医院误诊流产百例 议员促彻查温州五岁男童无故头部遭陌生男子砍两刀258位爱美者签约广美“祛斑终身包治点解金像奖上 他们都要感谢“高登先”大埔:“客家香格里拉”美如画卷“五一”出境短线游受宠,价格涨幅不明1959年,南海各地盛产什么?四川黄龙再次拍到野生大熊猫瑞安集聚全民之力 重塑秀美水乡休闲梅州:文化旅游发展的全新标杆父亲倒车 撞死两岁女儿望“范”兴叹鲁冠球:个人退休暂无时间表邪魅少爷萧梦官场九重天万历十八年英雄护群芳虫族异世纪绿茵灵猴金婴重生之克隆武神拽小子生化末日之求生横琴岛旅游攀枝花旅游白山旅游吉安旅游哈巴雪山旅游宜春旅游朱家峪旅游泸州旅游巴丹吉林旅游黔南旅游克拉玛依旅游
备案号:鲁ICP备13029499号-2 说三道四 www.s3d4.cn 说三道四技术文摘