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

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 ) {
    // ...
};
// ...

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