工欲善其事必先利其器，在此給給 Web 開(kāi)發(fā)人員推薦幾款優(yōu)秀的開(kāi)源文檔生成工具，希望能對(duì)大家有所幫助。

這是一款根據(jù) Javascript 文件中注釋信息，生成 JavaScript 應(yīng)用、庫(kù)、模塊的 API 文檔的工具。你可以使用它記錄如：命名空間、類(lèi)、方法、方法參數(shù)等。該項(xiàng)目還衍生出了許多模板和其他工具來(lái)幫助生成和自定義文檔，比如：

模板

• 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

構(gòu)建工具

• 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:///@kevinast/integrate-gitbook-jsdoc-974be8df6fb3

一個(gè) JavaScript 文檔生成器，按照規(guī)范編寫(xiě)代碼注釋?zhuān)纯缮捎押玫?JavaScript 代碼文檔。它可以將測(cè)試代碼和用戶(hù)手冊(cè)一并集成到文檔中，支持通過(guò)插件添加自定義功能。

Demo

這是一款 RESTful Web API 文檔生成工具，一個(gè)在注釋里邊編寫(xiě) API 文檔的小工具。有了它，只需在寫(xiě)源碼的時(shí)候順手寫(xiě)上一些簡(jiǎn)單的注釋?zhuān)涂梢陨沙銎恋奈臋n了。項(xiàng)目支持大部分主流語(yǔ)言，注釋維護(hù)起來(lái)也比較方便，不需要額外再維護(hù)一份文檔。

Demo

這是一款將任意 GraphQL API 表示為交互式圖形的工具，可以直觀地瀏覽 GraphQL API 。在設(shè)計(jì)或討論數(shù)據(jù)模型時(shí)，非常有用。

KSS 既是一份文檔規(guī)格說(shuō)明，也是一種編寫(xiě)樣式指南的格式，旨在幫助開(kāi)發(fā)者自動(dòng)化地創(chuàng)建可讀、可解析的樣式指南。它為團(tuán)隊(duì)編寫(xiě)具有可維護(hù)性、可文檔化的 CSS 提供一套方法。

顧名思義，這是一款 React 樣式指南生成器，可與你的團(tuán)隊(duì)分享在線樣式指南。它列出組件支持類(lèi)型，并展示基于 Markdown 文件的實(shí)時(shí)、可編輯的使用示例。

Demo