微信号:FrontDev

介绍:分享 Web 前端相关的技术文章、工具资源、精选课程、热点资讯

给 Web 开发人员推荐的文档生成工具

2018-05-19 17:04 前端大全

(点击上方公众号,可快速关注)


来源:oschina 

https://my.oschina.net/editorial-story/blog/1541328


工欲善其事必先利其器,在此给 Web 开发人员推荐几款优秀的开源文档生成工具,希望能对大家有所帮助。


1、JavaScript


JSDoc 3


这是一款根据 Javascript 文件中注释信息,生成 JavaScript 应用、库、模块的 API 文档的工具。你可以使用它记录如:命名空间、类、方法、方法参数等。该项目还衍生出了许多模板和其他工具来帮助生成和自定义文档,比如:


模板


  • jaguarjs-jsdoc

  • DocStrap (example)

  • jsdoc3Template (example)

  • minami

  • docdash (example)

  • tui-jsdoc-template (example)


构建工具


  • JSDoc Grunt plugin

  • JSDoc Gulp plugin


其它工具


  • jsdoc-to-markdown

  • Integrating GitBook with JSDoc


ESDoc


一个 JavaScript 文档生成器,按照规范编写代码注释,即可生成友好的 JavaScript 代码文档。它可以将测试代码和用户手册一并集成到文档中,支持通过插件添加自定义功能。


Demo(https://try.esdoc.org/)



2、API


apiDoc


这是一款 RESTful Web API 文档生成工具,一个在注释里边编写 API 文档的小工具。有了它,只需在写源码的时候顺手写上一些简单的注释,就可以生成出漂亮的文档了。项目支持大部分主流语言,注释维护起来也比较方便,不需要额外再维护一份文档。


Demo(http://apidocjs.com/#demo)



GraphQL Voyager


这是一款将任意 GraphQL API 表示为交互式图形的工具,可以直观地浏览 GraphQL API 。在设计或讨论数据模型时,非常有用。



3、CSS / Style Guide


Knyle Style Sheets(KSS)


KSS 既是一份文档规格说明,也是一种编写样式指南的格式,旨在帮助开发者自动化地创建可读、可解析的样式指南。它为团队编写具有可维护性、可文档化的 CSS 提供一套方法。



React Styleguidist


顾名思义,这是一款 React 样式指南生成器,可与你的团队分享在线样式指南。它列出组件支持类型,并展示基于 Markdown 文件的实时、可编辑的使用示例。


Demo(https://react-styleguidist.js.org/examples/basic/)




觉得本文对你有帮助?请分享给更多人

关注「前端大全」,提升前端技能

 
前端大全 更多文章 小册上新 | 区块链开发入门:从 0 到 1 构建基于以太坊智能合约 用 500 行纯前端代码在浏览器中构建一个 Tableau WebAssembly 对比 JavaScript 及其使用场景 学会这 3 点,完成前端小白到专家的蜕变 毕业一年左右的前端妹子面经总结
猜您喜欢 MongoDB 3.0新增特性一览 致运维同仁:您想换个新工作?我们来帮忙!| 运维内推 Javascript 的同步加载和执行 《抽丝剥茧之MySQL疑难杂症排查》2016 PG大象会分享PPT 你真的能看懂测试报告吗?