2

名前空間がモジュールの外部で定義されている jsdoc-toolkit を使用して、特定のモジュール パターン内の関数を文書化しようとしています。それに接続される関数は、即時呼び出し関数内にあります。ツールの出力から得られるものは次のとおりです。

警告: ドキュメント化されていないシンボル CORE のメンバーとして isObject をドキュメント化しようとしています。

コードの簡略版は次のとおりです。

/**
 * @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);
4

1 に答える 1

2

タグを試してみてください@memberOf。これにより、オブジェクトの「親」またはコンテナーと見なされるものを文書化できます。

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

構文: @memberOf parentNamepath、parentNamepath は、含まれているオブジェクトの名前パスです。

于 2012-06-29T13:22:08.970 に答える