?2016-2026 Matools All rights reserved,
粵ICP備17059708號(hào)
目錄
* 一.問題描述 <https://www.cnblogs.com/dashnowords/p/11166725.html#一.問題描述>
* 二. 處理方法 <https://www.cnblogs.com/dashnowords/p/11166725.html#二.-處理方法>
* 三. YUIdoc工具介紹
<https://www.cnblogs.com/dashnowords/p/11166725.html#三.-yuidoc工具介紹>
示例代碼托管在：http://www.github.com/dashnowords/blogs
<http://www.github.com/dashnowords/blogs>
博客園地址：《大史住在大前端》原創(chuàng)博文目錄 <https://www.cnblogs.com/dashnowords/p/10127926.html>
華為云社區(qū)地址：【你要的前端打怪升級(jí)指南】
<https://bbs.huaweicloud.com/blogs/8ae7e6420a4611e9bd5a7ca23e93a891>
一.問題描述
最近向一些同事推薦了網(wǎng)頁中實(shí)現(xiàn)流程圖繪制的工具庫jsplumb.js，Community版本是開源的，在github的官方倉庫的Wiki
中能夠找到社區(qū)版的官方指南，非常非常詳細(xì)。但是在后來很多人反饋說找不到API文檔，github官方倉庫中的API文檔鏈接失效了，jsplumb.js
官網(wǎng)也找不到。
二. 處理方法
其實(shí)API文檔就放在官方代碼倉中，只是需要一些小小的加工，具體步驟如下：
1.先從官方代碼倉https://github.com/jsplumb/jsplumb
<https://github.com/jsplumb/jsplumb> 將master分支的工程拉取到本地
2.使用npm install yuidocjs -g 或yarn global add yuidocjs全局安裝文檔工具YUIdoc
3.進(jìn)入剛才下載的工程目錄中的/doc/api文件夾
4.打開cmd小黑窗，輸入yuidoc .（yuidoc后面是1個(gè)空格1個(gè)點(diǎn)號(hào)）
YUIdoc就會(huì)在當(dāng)前目錄新建一個(gè)out文件夾，并將文檔輸出為本地靜態(tài)網(wǎng)站，完成后只需要打開out目錄中的index.html就可以本地查看API
離線文檔了，下圖即是YUIdoc默認(rèn)樣式生成的離線文檔：
怎么樣，這個(gè)技能你Get到了嗎？
三. YUIdoc工具介紹
官方倉庫：https://github.com/yui/yuidoc <https://github.com/yui/yuidoc>
YUIdoc是一個(gè)基于模板引擎Handlebars.js 的自動(dòng)化文檔工具，可以將javascript中jsdoc
風(fēng)格的注釋語句轉(zhuǎn)換成靜態(tài)網(wǎng)站式的離線文檔，所以你可以通過定制模板來為最終生成的文檔增加不同的主題樣式。jsdoc風(fēng)格通常都會(huì)有IDE插件直接生成（vscode和
sublime里肯定是有的，因?yàn)槲易约禾焯煊茫?，最常見的是函?shù)聲明注釋，YUIdoc中可以識(shí)別的所有語法可以查看官方提供的【YUIdoc支持的注釋語法】
<http://yui.github.io/yuidoc/syntax/index.html>：
//jsdoc風(fēng)格的注釋 /** * My method description. Like other pieces of your comment
blocks, * this can span multiple lines. * * @method methodName * @param
{String} foo Argument 1 * @param {Object} config A config object * @param
{String} config.name The name on the config object * @param {Function}
config.callback A callback function on the config object * @param {Boolean}
[extra=false] Do extra, optional work * @return {Boolean} Returns true on
success */
你可以通過-e參數(shù)來指定注釋文件的格式，例如你的工程是基于Typescript開發(fā)的，就可以使用yuidoc . -e .ts將項(xiàng)目中的*.d.ts
聲明文件轉(zhuǎn)換成離線文檔，以便團(tuán)隊(duì)內(nèi)部查閱。如果你開發(fā)的是一個(gè)工具庫，需要生成完備的API文檔，為了不影響源碼閱讀和開發(fā)，可以像jsplumb.js
那樣將注釋語句單獨(dú)寫在一個(gè)文件中，因?yàn)槭且粋€(gè)自動(dòng)化工具，也沒什么太多可講的，有需要的朋友直接瀏覽一下官網(wǎng)就可以很容易地使用了。
熱門工具 換一換