全国热线

400-080-3312

全国监督投诉热线:9:00-23:00

一分钟教你学会文档生成工具

今天南京学码思web培训机构老师就来给大家推荐几款优秀的开源文档生成工具,一起来学习一下吧。

同样是web前端工程师,做同样的工作,为什么有些人能够在短时间内完成所有工作,有些人却拖拖拉拉完成不了呢?除了能力和态度问题,还有个很重要的原因就是工具的使用,学会在工作中使用工具,是能够大大提高工作效率的,所谓工欲善其事必先利其器就是这个道理。今天南京学码思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


2、CSS / Style Guide


Knyle Style Sheets(KSS)


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


React Styleguidist


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


3、API


apiDoc


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


Demo


GraphQL Voyager


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


一分钟学会这几个文档生成工具,再来做web前端开发,你看会不会高效一些呢?南京学码思web培训机构遵循学习规律,设置课程体系,丰富的web前端教程,还有专业的师资团队带领大家入行,想学web前端,来南京学码思没错!


上一篇:如何利用css代码实现不同网页尺寸适配
下一篇:分享web前端性能优化的几个方法

相关推荐

免费试听 | 学费咨询 | 在线报名 | 申请补贴 | 软件培训 | 网站地图

2016-2020 南京学码思教育科技有限公司 .All Rights Reserved

苏ICP备16033487号 www.njxms.com.cn

全国热线

400-080-3312

全国监督服务热线:9:00-23:00