給 Web 開發人員推薦的文件生成工具

發表於2017-10-31

工欲善其事必先利其器,在此給 Web 開發人員推薦幾款優秀的開源文件生成工具,希望能對大家有所幫助。

1、JavaScript

JSDoc 3

這是一款根據 Javascript 檔案中註釋資訊,生成 JavaScript 應用、庫、模組的 API 文件的工具。你可以使用它記錄如:名稱空間、類、方法、方法引數等。該專案還衍生出了許多模板和其他工具來幫助生成和自定義文件,比如:

模板

構建工具

其它工具

ESDoc

一個 JavaScript 文件生成器,按照規範編寫程式碼註釋,即可生成友好的 JavaScript 程式碼文件。它可以將測試程式碼和使用者手冊一併整合到文件中,支援通過外掛新增自定義功能。

Demo

給 Web 開發人員推薦的文件生成工具

2、API

apiDoc

這是一款 RESTful Web API 文件生成工具,一個在註釋裡邊編寫 API 文件的小工具。有了它,只需在寫原始碼的時候順手寫上一些簡單的註釋,就可以生成出漂亮的文件了。專案支援大部分主流語言,註釋維護起來也比較方便,不需要額外再維護一份文件。

Demo

給 Web 開發人員推薦的文件生成工具

GraphQL Voyager

這是一款將任意 GraphQL API 表示為互動式圖形的工具,可以直觀地瀏覽 GraphQL API 。在設計或討論資料模型時,非常有用。

3、CSS / Style Guide

Knyle Style Sheets(KSS)

KSS 既是一份文件規格說明,也是一種編寫樣式指南的格式,旨在幫助開發者自動化地建立可讀、可解析的樣式指南。它為團隊編寫具有可維護性、可文件化的 CSS 提供一套方法。

給 Web 開發人員推薦的文件生成工具

React Styleguidist

顧名思義,這是一款 React 樣式指南生成器,可與你的團隊分享線上樣式指南。它列出元件支援型別,並展示基於 Markdown 檔案的實時、可編輯的使用示例。

Demo

相關文章