给 Web 开发人员推荐的文档生成工具
来源:互联网 发布:邮箱绑域名有什么用 编辑:程序博客网 时间:2024/05/18 01:40
(点击上方公众号,可快速关注)
来源: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/)
觉得本文对你有帮助?请分享给更多人
关注「前端大全」,提升前端技能
- 给 Web 开发人员推荐的文档生成工具
- 给 Web 开发人员推荐的文档生成工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给开发人员的实用命令行工具
- 推荐给JavaScript开发人员的10个工具
- 推荐给开发人员的6个实用命令行工具
- API文档生成工具推荐
- 给大家推荐一款测试数据生成工具(开源的)
- 推荐给软件开发人员的读书列表
- imx6ul设备树pinctrl解析
- Codeforces Round #444 (Div. 2) 总结
- 设计模式思想工厂模式
- 洛谷P2898haybale猜测Haybale Guessing
- Beta分布,二项分布,Dirichlet分布,多项式分布新解
- 给 Web 开发人员推荐的文档生成工具
- 面向对象:每天早上醒来,看见你和阳光都在,这便是我想要的未来
- Angular 5.0 来了,有这些大变化
- 简单工厂模式(思想)
- 【第1099期】Eruda: 手机网页调试利器
- 小程序内嵌网页能力开放
- oracle的DML,DCL,DDL区别
- windows窗体
- Ajax 的全面总结