免费视频淫片aa毛片_日韩高清在线亚洲专区vr_日韩大片免费观看视频播放_亚洲欧美国产精品完整版

打開APP
userphoto
未登錄

開通VIP,暢享免費(fèi)電子書等14項(xiàng)超值服

開通VIP
給 Web 開發(fā)人員推薦的文檔生成工具


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


1、JavaScript


JSDoc 3

https://www.oschina.net/p/jsdoc

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

模板

  • jaguarjs-jsdoc:https://github.com/davidshimjs/jaguarjs-jsdoc

  • DocStraphttps://github.com/docstrap/docstrap

  • jsdoc3Template:https://github.com/DBCDK/jsdoc3Template

  • minami:https://github.com/Nijikokun/minami

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


ESDoc

https://esdoc.org/

一個(gè) JavaScript 文檔生成器,按照規(guī)范編寫代碼注釋,即可生成友好的 JavaScript 代碼文檔。它可以將測(cè)試代碼和用戶手冊(cè)一并集成到文檔中,支持通過(guò)插件添加自定義功能。

Demo


2、API


apiDoc

http://apidocjs.com/

這是一款 RESTful Web API 文檔生成工具,一個(gè)在注釋里邊編寫 API 文檔的小工具。有了它,只需在寫源碼的時(shí)候順手寫上一些簡(jiǎn)單的注釋,就可以生成出漂亮的文檔了。項(xiàng)目支持大部分主流語(yǔ)言,注釋維護(hù)起來(lái)也比較方便,不需要額外再維護(hù)一份文檔。

Demo


GraphQL Voyager

https://apis.guru/graphql-voyager/

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


3、CSS / Style Guide


Knyle Style Sheets(KSS)

http://warpspire.com/kss

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


React Styleguidist

https://react-styleguidist.js.org/

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

Demo



本站僅提供存儲(chǔ)服務(wù),所有內(nèi)容均由用戶發(fā)布,如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請(qǐng)點(diǎn)擊舉報(bào)
打開APP,閱讀全文并永久保存 查看更多類似文章
猜你喜歡
類似文章
2019年13大GraphQL工具和庫(kù)
2020年Web前端需要掌握的10個(gè)關(guān)鍵技能
怎樣編寫好的API?看完你就知道了!
GraphQL[0x01] -- GraphQL基礎(chǔ)實(shí)踐
如何用markdown寫文檔?這個(gè)方法就能做到
(轉(zhuǎn)載)軟件工程師文檔寫作最佳實(shí)踐
更多類似文章 >>
生活服務(wù)
分享 收藏 導(dǎo)長(zhǎng)圖 關(guān)注 下載文章
綁定賬號(hào)成功
后續(xù)可登錄賬號(hào)暢享VIP特權(quán)!
如果VIP功能使用有故障,
可點(diǎn)擊這里聯(lián)系客服!

聯(lián)系客服