Question

我正在尝试使用jsdoc-toolkit记录特定模块模式中的函数，其中命名空间是在模块外部定义的。附加到它的函数位于立即调用函数内。我从工具输出中得到的是：

警告：尝试将isObject记录为未记录的符号CORE的成员。

以下是代码的简化版本：

/**
 * @namespace The framework's top namespace
 * */
var FX = {
  /**
   * @namespace The core framework functions
   */
  core: {
  }
};

(function( CORE, GLOBAL ) {

    'use strict';

    var _isObject;

    CORE.isObject = _isObject = function( object ) {

        if (null === object || (void 0) === object) {
            return false
        }

        return true;

    };

    return CORE;

})(this.FX.core, this);

Answer 1

您可以尝试@memberOf标记，该标记允许您记录您认为对象的“父”或容器的内容。

/** 
 * @memberOf FX.core 
 */
CORE.isObject = _isObject = function( object ) {
    // ...
};
// ...

语法：@memberOf parentNamepath，parentNamepath是包含对象的名称路径。

如何在使用模块模式时使用JSDoc记录子命名空间

1 个答案: