如何使用JSDoc在另一个私有对象中记录私有对象

时间:2012-04-26 07:38:37

标签: javascript jsdoc

我正在使用jsdoc工具包来记录项目,我在一个问题中记录了另一个私有对象中的私有对象。

我收到了这个警告:

  
    

警告:尝试将连接记录为未记录的符号testObject的成员。

  

但是testObject在我的Docs输出中很好地显示为'{Object} testObject'

这是javascript文件测试:

/* 
 * @fileOverview Various Test functions.
 * @author Regards
 */

 /**
 * @description testUtilsNameSpace 'namespace' helps 
 * @name testUtils
 * @type Object
 * @namespace
 **/
(function($) {
'use strict';

    /**
    * @description minPageReached private var
    * @private
        * @type number
    * @name testUtils#minPageReached
    * @field
    */
    var minPageReached = 0;

    /**
     * @description maxPageReached public var
     * @type number
     */
    testUtils.maxPageReached = 0;

    /**
     * @description testPrivate private function
     * @inner
     * @param {page} page Info on the page you want to request
     * @type Function
     * @memberOf testUtils
     */
    var testPrivate = function(page){
        console.log("testPrivate");
    };

    /**
     * @description testPublic public function
     * @param {page} page Info on the page you want to request
     * @type Function
     * @memberOf testUtils
     */
    testUtils.testPublic = function(page){
            console.log("testPublic");
    }


    /**
     * @description loadDependencies function
     * @type Function
     * @memberOf testUtils
     */
    var loadDependencies = function() {

    };

    /**
    * @description testObject
    * @private
    * @field
    * @name testUtils#testObject
    * @type Object
    */
    var testObject = {

            /**
             * @description connection object
             * @field
             * @name testObject#connection
             * @type Object
             */
            connection: {

            }

    }

})(window.jQuery);

0 个答案:

没有答案