摘要:融合思路解決這個問題,有兩種思路。給我們帶來了以下新成員模塊服務(wù)指令篩選器和控制器。與其他類是通過類的名稱區(qū)分的,名稱統(tǒng)一以結(jié)尾。這種處理方式是一種折中方案,如果想要更加規(guī)范優(yōu)雅的話,建議使用自定義標(biāo)簽來解決。
字?jǐn)?shù):1568
閱讀時間:10分鐘
??前面,我們以一個實戰(zhàn)案例來詳細說明了如何在實際開發(fā)中使用JSDuck工具。但是,并不是所有的時候,代碼的封裝方式都受我們控制的。例如,如果我們使用了現(xiàn)在的幾個主流框架AngularJS、React或者Vue的時候,代碼的封裝方式就必須按照框架定義的方式來構(gòu)建。當(dāng)我們的代碼中出現(xiàn)了模塊、控制器、服務(wù)、指令等JSDuck完全不認(rèn)識的組成部分時,我們該如何使用JSDuck來正確描述我們的代碼呢?
??那么,下面,筆者就以 AngularJS 為例,來說一說筆者自己的解決方案。
??解決這個問題,有兩種思路。第一種,可以將JSDuck不識別的代碼部分映射到工具識別的標(biāo)簽來進行描述。第二種,既然沒有現(xiàn)成的標(biāo)簽來描述這些新成員,那我們可以自定義一套標(biāo)簽來描述它們。
??第一種方法更方便,不需要額外編碼;第二種方法更優(yōu)雅,但是需要自定義一整套標(biāo)簽。
??這里,由于筆者對文檔的要求主要是實用,不需要那么完美,而且現(xiàn)在也沒有過多的精力來研發(fā)一整套標(biāo)簽。所以,筆者選擇了第一種解決方案。
??第一種方案最核心的地方就是需要確定AngularJS框架給我們的代碼帶來了哪些新成員,而后如何將這些新成員映射到原有的標(biāo)簽中去。
??AngularJS給我們帶來了以下新成員:模塊、服務(wù)、指令、篩選器和控制器。然后映射關(guān)系如下:
新成員 | 映射的JSDuck標(biāo)簽 |
---|---|
模塊 | 模塊類(@class) |
服務(wù) | 服務(wù)類(@class) |
指令 | 模塊類中的函數(shù)(@method) |
篩選器 | 模塊類中的函數(shù)(@method) |
控制器 | 控制器類(@class) |
??其中,模塊是一個特殊的類,我叫它模塊類,它和其他的類是通過命名空間和類名來區(qū)分的。例如,NgModule.layout ,就是我的一個模塊類,NgModule 這個命名空間就是專門存放模塊類的命名空間。
??服務(wù)是另一種特殊的類,我叫它服務(wù)類,服務(wù)類和模塊類是通過命名空間來關(guān)聯(lián)的,并且服務(wù)類的名稱比較特殊,統(tǒng)一以 “$” 符號開頭。例如 , NgModule.layout.$layoutTag 就是我的一個服務(wù)類,它的命名空間就是它所屬的模塊類。
??指令和篩選器就比較簡單了,他們都是所屬模塊類中的函數(shù)。
??控制器也是一個特殊的類,我叫他控制器類,它的命名空間是它所屬模塊類。與其他類是通過類的名稱區(qū)分的,名稱統(tǒng)一以”Ctrl“結(jié)尾。例如:NgModule.frame3.frameCtrl 就是我的一個控制器類。這里,父子控制器就直接通過父類子類來表示。
??整體的思路就是如此,那么,下面咱還是直接上代碼來說話吧!
??如下所示,就是我們的一個模塊類的部分代碼(為了方便查看,只留下了注釋,刪掉了具體實現(xiàn)):
/** * 頁面通用小控件模塊 * @class NgModule.layout * @alias gm.ngCustom.layout * @author lsjcoder */ angular.module("gm.ngCustom.layout",[]).provider("$layoutTag", /** * 表示查詢項的標(biāo)簽的服務(wù) * @class NgModule.layout.$layoutTag * @alias $layoutTag * @author lsjcoder */ function() { this.$get = [function () { function factory() { var $layout = {}; /** * @member NgModule.layout.$layoutTag * @method getCheckedTags 獲取選中的標(biāo)簽 * @param {Array} tags 標(biāo)簽集合 * @returns {Array} 選中的標(biāo)簽集合 */ $layout.getCheckedTags = function(tags){ }; /** * @member NgModule.layout.$layoutTag * @method clearCheck 清空選擇 * @param {Array} tags 標(biāo)簽集合 */ $layout.clearCheck = function(tags){ }; return $layout; } return factory; }]; }).directive("gmTags",["$layoutTag", /** * @member NgModule.layout * @method gmTags 標(biāo)簽指令,EAC模式 * @param {Number} [max-tag-num] DOM屬性傳值,外部顯示出來的標(biāo)簽最大個數(shù),默認(rèn)會自動根據(jù)頁面寬度計算 * @param {Boolean} [multi = true] DOM屬性傳值,是否開啟多選模式 * @param {Object} tagdata 作用于傳值,指令配置項 * @param {String} tagdata.checkTag 選中標(biāo)簽后調(diào)用函數(shù)的名稱 * @param {Array} tagdata.tags 標(biāo)簽數(shù)據(jù) */ function($layoutTag){ //查詢表單中標(biāo)簽指令 return { restrict: "ECA", templateUrl: "tag.tpl.html", replace: true, scope: { tagdata: "=" }, link: function (scope, element, attr, transclution) { } } }]).directive("dateChoose", /** * @member NgModule.layout * @method dateChoose 日期指令,EAC模式 */ function(){ return { restrict:"EAC", link :function(scope,element,attr,transclution){ } } }).directive("timeChoose", /** * @member NgModule.layout * @method timeChoose 時間指令,EAC模式 */ function(){ return { restrict:"EAC", link :function(scope,element,attr,transclution){ } } });
??代碼上看已經(jīng)很清晰了,這段代碼包含了模塊以及模塊中服務(wù)和指令的注釋方式。篩選器同指令,就不做贅述了。
??下面,我們再看看控制器的注釋方式:
/** * @class NgModule.frame3 frame3模塊 * @alias frame3 * @author lsjcoder */ var frameApp = angular.module("frameApp",[]); /** * @class NgModule.frame3.frameCtrl 框架控制器 * @extends NgModule.frame.frameCtrl * @author lsjcoder */ frameApp.controller("frameCtrl",["$scope",function($scope){ /** * @member NgModule.frame3.frameCtrl * @method refreshPage 刷新路由頁面 * @param {String} strPath 路由地址 * @author lsjcoder */ $scope.refreshPage = function(strPath){ }; }]);
??如上代碼所示,我聲明了一個控制器 NgModule.frame3.frameCtrl ,它屬于模塊 NgModule.frame3 ,父控制器是 NgModule.frame.frameCtrl ,內(nèi)部有一個函數(shù)成員 refreshPage 。
??至此,我們就可以按照這種方式來描述所有因為使用 AngularJS 框架而新增的代碼部分了。其他的框架也可以使用相同的辦法來處理。這種處理方式是一種折中方案,如果想要更加規(guī)范、優(yōu)雅的話,建議使用自定義標(biāo)簽來解決。
??歡迎大伙關(guān)注我的微信公眾號,和老司機一起擼代碼:
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/90721.html
摘要:本文比較了種較為主流的注釋文檔生成工具。應(yīng)該說是非常適合開源項目多個作者共同維護的一個文檔工具。最后我選擇了作為文檔生成的工具。為了支持多種語言,它僅對注釋塊內(nèi)部的內(nèi)容進行解析。 最近隨著寫Node以及獨立的CommonJS模塊越來越多,我發(fā)現(xiàn)有一份好的文檔不僅可以幫助自己在應(yīng)用這些接口的時候不至于迷糊,而且對于共同開發(fā)的情況下,能夠省去大量團隊的交流和Debug的時間。 本文比較了...
摘要:我們在對現(xiàn)在較主流的五個文檔工具分別作了調(diào)研和嘗試,得到結(jié)論如下工具優(yōu)點缺點提供了完整的模板開發(fā)事件觸發(fā)等接口,使用非常靈活。至此,的環(huán)境部署已經(jīng)全部完成了。 字?jǐn)?shù):981 閱讀時間:5分鐘 選型依據(jù) ? 在經(jīng)歷了數(shù)個上線的項目之后,筆者所在的團隊已經(jīng)沉淀了一個相對穩(wěn)定版本的前端框架。因此,我們需要出具一套框架API文檔,以便公司其他成員的使用和框架的后期維護。我們在對...
摘要:語法父類名表示當(dāng)前類繼承于哪個類的標(biāo)簽。成員標(biāo)簽成員標(biāo)簽作用于類中的配置屬性函數(shù)事件。表明可被子類繼承,和一起使用。示例獲取圓的面積圓的半徑面積值作用于函數(shù),表明函數(shù)的標(biāo)簽。作用于函數(shù),表明構(gòu)造函數(shù)參數(shù)的標(biāo)簽,用法同。 字?jǐn)?shù):3692字 閱讀時間:15分鐘 前言 ? 首先,咱們有一個前提,JSDuck對我們而言只是一個便于API查看的文檔化工具。因此,只要它能夠滿足我們文...
摘要:我們先聲明了類,在類的注釋上添加標(biāo)簽表示靜態(tài)類。靜態(tài)類中包含一個方法,實現(xiàn)了一個簡單的擴展功能,后面類的繼承需要用到這個接口。這里需要注意,靜態(tài)類中,所有的成員也都是靜態(tài)的。 字?jǐn)?shù):2543 閱讀時間:15分鐘 前言 ? 上一篇文章我們講述了JSDuck的詳細用法。那么,本文筆者就以實例為基礎(chǔ),和大家一起,從零開始,搭建一個簡單的API文檔——我們的第一個API文檔V0.0.1。...
閱讀 657·2021-11-25 09:43
閱讀 1928·2021-11-17 09:33
閱讀 842·2021-09-07 09:58
閱讀 2076·2021-08-16 10:52
閱讀 494·2019-08-30 15:52
閱讀 1736·2019-08-30 15:43
閱讀 1016·2019-08-30 15:43
閱讀 2938·2019-08-29 16:41