工慾善其事必先利其器,在此給 Web 開發人員推薦幾款優秀的開源文檔生成工具,希望能對大家有所幫助。
1、JavaScript
JSDoc 3
這是一款根據 Javascript 文件中註釋信息,生成 JavaScript 應用、庫、模塊的 API 文檔的工具。你可以使用它記錄如:命名空間、類、方法、方法參數等。該項目還衍生出了許多模板和其他工具來幫助生成和自定義文檔,比如:
模板
- jaguarjs-jsdoc
- DocStrap (example)
- jsdoc3Template (example)
- minami
- docdash (example)
- tui-jsdoc-template (example)
構建工具
其它工具
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 文件的實時、可編輯的使用示例。
自己是一個五年的前端工程師
這裏推薦一下我的前端學習交流羣:784783012 ,裏面都是學習前端的,如果你想製作酷炫的網頁,想學習知識。自己整理了一份2018最全面前端學習資料,從最基礎的HTML+CSS+JS到移動端HTML5到各種框架都有整理,送給每一位前端小夥伴,有想學習web前端的,或是轉行,或是大學生,還有工作中想提升自己能力的,正在學習的小夥伴歡迎加入學習。