795
技術社區[雲棲]
給 Web 開發人員推薦的文檔生成工具
工欲善其事必先利其器，在此給 Web 開發人員推薦幾款優秀的開源文檔生成工具，希望能對大家有所幫助。
1、JavaScript
JSDoc 3
這是一款根據 Javascript 文件中注釋信息，生成 JavaScript 應用、庫、模塊的 API 文檔的工具。你可以使用它記錄如：命名空間、類、方法、方法參數等。該項目還衍生出了許多模板和其他工具來幫助生成和自定義文檔，比如：
模板
構建工具
其它工具
ESDoc
一個 JavaScript 文檔生成器，按照規範編寫代碼注釋，即可生成友好的 JavaScript 代碼文檔。它可以將測試代碼和用戶手冊一並集成到文檔中，支持通過插件添加自定義功能。
2、API
apiDoc
這是一款 RESTful Web API 文檔生成工具，一個在注釋裏邊編寫 API 文檔的小工具。有了它，隻需在寫源碼的時候順手寫上一些簡單的注釋，就可以生成出漂亮的文檔了。項目支持大部分主流語言，注釋維護起來也比較方便，不需要額外再維護一份文檔。
GraphQL Voyager
這是一款將任意 GraphQL API 表示為交互式圖形的工具，可以直觀地瀏覽 GraphQL API 。在設計或討論數據模型時，非常有用。
3、CSS / Style Guide
Knyle Style Sheets（KSS）
KSS 既是一份文檔規格說明，也是一種編寫樣式指南的格式，旨在幫助開發者自動化地創建可讀、可解析的樣式指南。它為團隊編寫具有可維護性、可文檔化的 CSS 提供一套方法。
React Styleguidist
顧名思義，這是一款 React 樣式指南生成器，可與你的團隊分享在線樣式指南。它列出組件支持類型，並展示基於 Markdown 文件的實時、可編輯的使用示例。
本文作者：佚名
來源：51CTO
最後更新：2017-11-02 11:33:56