给 Web 开发人员推荐的文档生成工具——爱创课堂

工欲善其事必先利其器，在此给给 Web 开发人员推荐几款优秀的开源文档生成工具，但愿能对你们有所帮助。

 

 

一、JavaScript

 

 

JSDoc 3

https://www.oschina.net/p/jsdoc

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

 

模板

• jaguarjs-jsdoc：https://github.com/davidshimjs/jaguarjs-jsdoc

• DocStrap：https://github.com/docstrap/docstrap

• jsdoc3Template：https://github.com/DBCDK/jsdoc3Template

• minami：https://github.com/Nijikokun/minami

• docdash：https://github.com/clenemt/docdash

• tui-jsdoc-template：https://github.com/nhnent/tui.jsdoc-template

 

构建工具

• JSDoc Grunt plugin：https://github.com/krampstudio/grunt-jsdoc

• JSDoc Gulp plugin：https://github.com/mlucool/gulp-jsdoc3

 

其它工具

• jsdoc-to-markdown：https://github.com/jsdoc2md/jsdoc-to-markdown

• Integrating GitBook with JSDoc：https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3

 

ESDoc

https://esdoc.org/

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

Demo

 

 

二、API

 

 

apiDoc

http://apidocjs.com/

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

Demo

 

GraphQL Voyager

https://apis.guru/graphql-voyager/

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

 

 

三、CSS / Style Guide

 

 

Knyle Style Sheets（KSS）

http://warpspire.com/kss

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

 

React Styleguidist

https://react-styleguidist.js.org/

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

Demo