給 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