Jsduck的使用

alaege 發(fā)布于2019-08-22 11:10 / 3388人閱讀

摘要：簡(jiǎn)介是眾多開(kāi)源項(xiàng)目中的一個(gè)，它是使用編寫(xiě)的文檔生成器。系統(tǒng)環(huán)境變量，對(duì)所有用戶起作用。使用可通過(guò)配置，也可通過(guò)直接在命令行寫(xiě)參數(shù)來(lái)使用。配置進(jìn)入項(xiàng)目目錄，配置文件，類(lèi)似以下的寫(xiě)法運(yùn)行命令，即可在文件夾下找到自動(dòng)生成的文檔。

簡(jiǎn)介

jsduck是senchalabs眾多開(kāi)源項(xiàng)目中的一個(gè)，它是使用ruby編寫(xiě)的 javascript API文檔生成器。不像JSDoc一樣，不按照符合JSDoc的注釋語(yǔ)法來(lái)進(jìn)行注釋的話，可能生成的文檔一個(gè)字也沒(méi)有，學(xué)習(xí)曲線較陡。jsduck適合以O(shè)OP方式構(gòu)造代碼（如Ext JS是結(jié)構(gòu)化的）的js文件，不適合以功能性風(fēng)格構(gòu)建代碼（如jQuery）的js文件。

安裝 下載安裝包

項(xiàng)目地址：https://github.com/senchalabs...
windows下安裝的話，可在這個(gè)地址下載.exe可執(zhí)行文件，將下載后的文件更名為jsduck.exe，放到一個(gè)目錄下面。

配置環(huán)境變量

windows下需要配置環(huán)境變量。環(huán)境變量分為系統(tǒng)環(huán)境變量和用戶環(huán)境變量?jī)煞N。系統(tǒng)環(huán)境變量，對(duì)所有用戶起作用。而用戶環(huán)境變量只對(duì)當(dāng)前用戶起作用。 我們可配置在用戶環(huán)境變量的path中，也可配置在系統(tǒng)環(huán)境變量的path中。
點(diǎn)擊計(jì)算機(jī)，右鍵選擇屬性——》高級(jí)-》環(huán)境變量，在Path中進(jìn)行設(shè)置。

配置完成，進(jìn)入dos命令，運(yùn)行jsduck --help，能出來(lái)信息，則表示配置成功。

使用

可通過(guò)配置jsduck.json，也可通過(guò)直接在命令行寫(xiě)參數(shù)來(lái)使用。

配置jsduck.json

進(jìn)入項(xiàng)目目錄，配置jsduck.json文件，類(lèi)似以下的寫(xiě)法

運(yùn)行jsduck命令，即可在dist文件夾下找到自動(dòng)生成的api文檔。

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/91899.html

相關(guān)文章

JSDuck用法詳解

摘要：語(yǔ)法父類(lèi)名表示當(dāng)前類(lèi)繼承于哪個(gè)類(lèi)的標(biāo)簽。成員標(biāo)簽成員標(biāo)簽作用于類(lèi)中的配置屬性函數(shù)事件。表明可被子類(lèi)繼承，和一起使用。示例獲取圓的面積圓的半徑面積值作用于函數(shù)，表明函數(shù)的標(biāo)簽。作用于函數(shù)，表明構(gòu)造函數(shù)參數(shù)的標(biāo)簽，用法同。字?jǐn)?shù)：3692字閱讀時(shí)間：15分鐘前言 ? 首先，咱們有一個(gè)前提，JSDuck對(duì)我們而言只是一個(gè)便于API查看的文檔化工具。因此，只要它能夠滿足我們文...

xiaochao 2019-08-21 18:41 評(píng)論0 收藏0
五分鐘玩轉(zhuǎn)文檔化工具JSDuck

摘要：我們?cè)趯?duì)現(xiàn)在較主流的五個(gè)文檔工具分別作了調(diào)研和嘗試，得到結(jié)論如下工具優(yōu)點(diǎn)缺點(diǎn)提供了完整的模板開(kāi)發(fā)事件觸發(fā)等接口，使用非常靈活。至此，的環(huán)境部署已經(jīng)全部完成了。字?jǐn)?shù)：981 閱讀時(shí)間：5分鐘選型依據(jù) ? 在經(jīng)歷了數(shù)個(gè)上線的項(xiàng)目之后，筆者所在的團(tuán)隊(duì)已經(jīng)沉淀了一個(gè)相對(duì)穩(wěn)定版本的前端框架。因此，我們需要出具一套框架API文檔，以便公司其他成員的使用和框架的后期維護(hù)。我們?cè)趯?duì)...

rickchen 2019-08-21 18:41 評(píng)論0 收藏0
Javascript自動(dòng)化文檔工具：YUI Doc, JSDoc 3, JSDuck等比較

摘要：本文比較了種較為主流的注釋文檔生成工具。應(yīng)該說(shuō)是非常適合開(kāi)源項(xiàng)目多個(gè)作者共同維護(hù)的一個(gè)文檔工具。最后我選擇了作為文檔生成的工具。為了支持多種語(yǔ)言，它僅對(duì)注釋塊內(nèi)部的內(nèi)容進(jìn)行解析。最近隨著寫(xiě)Node以及獨(dú)立的CommonJS模塊越來(lái)越多，我發(fā)現(xiàn)有一份好的文檔不僅可以幫助自己在應(yīng)用這些接口的時(shí)候不至于迷糊，而且對(duì)于共同開(kāi)發(fā)的情況下，能夠省去大量團(tuán)隊(duì)的交流和Debug的時(shí)間。本文比較了...

tyheist 2019-08-22 10:56 評(píng)論0 收藏0
JSDuck 與 AngularJS 融合技巧

摘要：融合思路解決這個(gè)問(wèn)題，有兩種思路。給我們帶來(lái)了以下新成員模塊服務(wù)指令篩選器和控制器。與其他類(lèi)是通過(guò)類(lèi)的名稱區(qū)分的，名稱統(tǒng)一以結(jié)尾。這種處理方式是一種折中方案，如果想要更加規(guī)范優(yōu)雅的話，建議使用自定義標(biāo)簽來(lái)解決。字?jǐn)?shù)：1568 閱讀時(shí)間：10分鐘前言 ??前面，我們以一個(gè)實(shí)戰(zhàn)案例來(lái)詳細(xì)說(shuō)明了如何在實(shí)際開(kāi)發(fā)中使用JSDuck工具。但是，并不是所有的時(shí)候，代碼的封裝方式都受我們控制的。...

CarterLi 2019-08-21 18:41 評(píng)論0 收藏0
JSDuck實(shí)戰(zhàn)

摘要：我們先聲明了類(lèi)，在類(lèi)的注釋上添加標(biāo)簽表示靜態(tài)類(lèi)。靜態(tài)類(lèi)中包含一個(gè)方法，實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的擴(kuò)展功能，后面類(lèi)的繼承需要用到這個(gè)接口。這里需要注意，靜態(tài)類(lèi)中，所有的成員也都是靜態(tài)的。字?jǐn)?shù)：2543 閱讀時(shí)間：15分鐘前言 ? 上一篇文章我們講述了JSDuck的詳細(xì)用法。那么，本文筆者就以實(shí)例為基礎(chǔ)，和大家一起，從零開(kāi)始，搭建一個(gè)簡(jiǎn)單的API文檔——我們的第一個(gè)API文檔V0.0.1。...

kel 2019-08-21 18:41 評(píng)論0 收藏0