如何查看jsplumb.js的API文檔(YUIdoc的基本使用)#華為云·尋找黑馬程序員#

示例代碼托管在：http://www.github.com/dashnowords/blogs

博客園地址：《大史住在大前端》原創(chuàng)博文目錄

華為云社區(qū)地址：【你要的前端打怪升級指南】

如何查看jsplumb.js的API文檔(YUIdoc的基本使用)一.問題描述二. 處理方法三. YUIdoc工具介紹

一.問題描述

最近向一些同事推薦了網(wǎng)頁中實現(xiàn)流程圖繪制的工具庫jsplumb.js，Community版本是開源的，在github的官方倉庫的Wiki中能夠找到社區(qū)版的官方指南，非常非常詳細(xì)。但是在后來很多人反饋說找不到API文檔，github官方倉庫中的API文檔鏈接失效了，jsplumb.js官網(wǎng)也找不到。

二. 處理方法

其實API文檔就放在官方代碼倉中，只是需要一些小小的加工，具體步驟如下：

1.先從官方代碼倉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個空格1個點號）

YUIdoc就會在當(dāng)前目錄新建一個out文件夾，并將文檔輸出為本地靜態(tài)網(wǎng)站，完成后只需要打開out目錄中的index.html就可以本地查看API離線文檔了，下圖即是YUIdoc默認(rèn)樣式生成的離線文檔：

怎么樣，這個技能你Get到了嗎？

三. YUIdoc工具介紹

官方倉庫：https://github.com/yui/yuidoc

YUIdoc是一個基于模板引擎Handlebars.js 的自動化文檔工具，可以將javascript中jsdoc風(fēng)格的注釋語句轉(zhuǎn)換成靜態(tài)網(wǎng)站式的離線文檔，所以你可以通過定制模板來為最終生成的文檔增加不同的主題樣式。jsdoc風(fēng)格通常都會有IDE插件直接生成（vscode和sublime里肯定是有的，因為我自己天天用），最常見的是函數(shù)聲明注釋，YUIdoc中可以識別的所有語法可以查看官方提供的【YUIdoc支持的注釋語法】：

//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將項目中的*.d.ts聲明文件轉(zhuǎn)換成離線文檔，以便團(tuán)隊內(nèi)部查閱。如果你開發(fā)的是一個工具庫，需要生成完備的API文檔，為了不影響源碼閱讀和開發(fā)，可以像jsplumb.js那樣將注釋語句單獨寫在一個文件中，因為是一個自動化工具，也沒什么太多可講的，有需要的朋友直接瀏覽一下官網(wǎng)就可以很容易地使用了。

開發(fā)者 API JavaScript

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。