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

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

这是一款根据 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

其它工具

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

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

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

Demo

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

Demo