資訊專欄INFORMATION COLUMN
摘要：簡介是眾多開源項目中的一個，它是使用編寫的文檔生成器。系統環境變量，對所有用戶起作用。使用可通過配置，也可通過直接在命令行寫參數來使用。配置進入項目目錄，配置文件，類似以下的寫法運行命令，即可在文件夾下找到自動生成的文檔。
簡介
jsduck是senchalabs眾多開源項目中的一個，它是使用ruby編寫的 javascript API文檔生成器。不像JSDoc一樣，不按照符合JSDoc的注釋語法來進行注釋的話，可能生成的文檔一個字也沒有，學習曲線較陡。jsduck適合以OOP方式構造代碼（如Ext JS是結構化的）的js文件，不適合以功能性風格構建代碼（如jQuery）的js文件。
安裝 下載安裝包項目地址：https://github.com/senchalabs...
windows下安裝的話，可在這個地址下載.exe可執行文件，將下載后的文件更名為jsduck.exe，放到一個目錄下面。
windows下需要配置環境變量。環境變量分為系統環境變量和用戶環境變量兩種。系統環境變量，對所有用戶起作用。而用戶環境變量只對當前用戶起作用。 我們可配置在用戶環境變量的path中，也可配置在系統環境變量的path中。
點擊計算機，右鍵選擇屬性——》高級-》環境變量，在Path中進行設置。
配置完成，進入dos命令，運行jsduck --help，能出來信息，則表示配置成功。
使用可通過配置jsduck.json，也可通過直接在命令行寫參數來使用。
配置jsduck.json進入項目目錄，配置jsduck.json文件，類似以下的寫法
運行jsduck命令，即可在dist文件夾下找到自動生成的api文檔。
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/91899.html
摘要：語法父類名表示當前類繼承于哪個類的標簽。成員標簽成員標簽作用于類中的配置屬性函數事件。表明可被子類繼承，和一起使用。示例獲取圓的面積圓的半徑面積值作用于函數，表明函數的標簽。作用于函數，表明構造函數參數的標簽，用法同。 字數：3692字 閱讀時間：15分鐘 前言 ? 首先，咱們有一個前提，JSDuck對我們而言只是一個便于API查看的文檔化工具。因此，只要它能夠滿足我們文...
摘要：我們在對現在較主流的五個文檔工具分別作了調研和嘗試，得到結論如下工具優點缺點提供了完整的模板開發事件觸發等接口，使用非常靈活。至此，的環境部署已經全部完成了。 字數：981 閱讀時間：5分鐘 選型依據 ? 在經歷了數個上線的項目之后，筆者所在的團隊已經沉淀了一個相對穩定版本的前端框架。因此，我們需要出具一套框架API文檔，以便公司其他成員的使用和框架的后期維護。我們在對...
摘要：本文比較了種較為主流的注釋文檔生成工具。應該說是非常適合開源項目多個作者共同維護的一個文檔工具。最后我選擇了作為文檔生成的工具。為了支持多種語言，它僅對注釋塊內部的內容進行解析。 最近隨著寫Node以及獨立的CommonJS模塊越來越多，我發現有一份好的文檔不僅可以幫助自己在應用這些接口的時候不至于迷糊，而且對于共同開發的情況下，能夠省去大量團隊的交流和Debug的時間。 本文比較了...
摘要：融合思路解決這個問題，有兩種思路。給我們帶來了以下新成員模塊服務指令篩選器和控制器。與其他類是通過類的名稱區分的，名稱統一以結尾。這種處理方式是一種折中方案，如果想要更加規范優雅的話，建議使用自定義標簽來解決。 字數：1568 閱讀時間：10分鐘 前言 ??前面，我們以一個實戰案例來詳細說明了如何在實際開發中使用JSDuck工具。但是，并不是所有的時候，代碼的封裝方式都受我們控制的。...
閱讀 3960·2021-11-24 09:38
閱讀 1225·2021-10-19 11:42
閱讀 1829·2021-10-14 09:42
閱讀 2154·2019-08-30 15:44
閱讀 544·2019-08-30 14:04
閱讀 2888·2019-08-30 13:13
閱讀 1949·2019-08-30 12:51
閱讀 956·2019-08-30 11:22
