使用jsdoc3來記錄模塊和子模塊

Question

我有一個遵循這種模式的模塊。

/** 
* @name Filters 
* @namespace 
*/ 
var Filters = (function (Filters, $) { 
    Filters.switchView = function (newView) { 
     // do something 
    }; 
    return Filters; 
})(Filters || {}, jQuery); 

我再有對過濾器模塊

Filters.validator = (function (Filters, $) { 
    var validator = {}; 
    validator.toggleErrorState = function (state, el) { 
     // do something 
    } 
    return validator; 
})(Filters || {}, jQuery); 

我無法弄清楚如何記錄子模塊的子模塊。我已經做了一些搜索，並沒有發現任何其他人遵循這個特定的模式，這是與jsdoc風格的評論文件。任何幫助將不勝感激。

Answer 1

這將記錄兩個名稱空間。第一個文件：

/** 
* @namespace 
*/ 
var Filters = (function (Filters, $) { 
    /** 
    * switchView does... 
    * @param newView The new view. 
    */ 
    Filters.switchView = function (newView) { 
     // do something 
    }; 
    return Filters; 
})(Filters || {}, jQuery); 

第二個文件：

/** 
* @namespace 
*/ 
Filters.validator = (function (Filters, $) { 
    var validator = {}; 
    /** 
    * toggleErrorState does... 
    * @param state The state. 
    * @param el The el. 
    */ 
    validator.toggleErrorState = function (state, el) { 
     // do something 
    } 
    return validator; 
})(Filters || {}, jQuery); 

Answer 2

/** 
* @namespace Parent 
*/ 
var Filters = (function (Filters, $) { 
    /** 
    * switchView does... 
    * @param newView The new view. 
    */ 
    Filters.switchView = function (newView) { 
     // do something 
    }; 
    return Filters; 
})(Filters || {}, jQuery); 

/** 
* @namespace Child 
* @memberOf Parent 
*/ 
Filters.validator = (function (Filters, $) { 
    var validator = {}; 
    /** 
    * toggleErrorState does... 
    * @param state The state. 
    * @param el The el. 
    */ 
    validator.toggleErrorState = function (state, el) { 
     // do something 
    } 
    return validator; 
})(Filters || {}, jQuery);