8

ユニオン内の名前空間とモジュールの目的を理解する際に問題に直面しました。たとえば、クラスがありGame.utils.Matrixます。Game名前空間、utilsモジュール、およびMatrixクラスとして注釈を付けたい:

/**
 * @namespace Game
 */

/**
 * @module utils
 * @memberOf Game
 */

/**
 * Create a matrix
 * @constructor
 */
function Matrix(){}

ドキュメントを作成し、Matrixクラスの名前パスは ですGame.utils~ Matrixが、Moduleリンクをたどると名前パスに名前空間プレフィックスがModule: utilsなく、リンクをたどるとモジュールリンクが含まれていません。GameGameutils

utilsさらに、このクラスはモジュールタブに表示されないため、このモジュールに別のクラスを追加することはできません。

/**
 * Create Dictionary
 * @memberOf Game.utils
 * @constructor
 */
function Dictionary(){}

問題は、名前空間とモジュールを文書化する正しい方法と、それぞれのユース ケースは何かということです。

4

1 に答える 1

6

少し遊んでみましたが、名前空間にモジュールを配置するのは少し難しいと思います。私にとってうまくいったのは、モジュールutilsとそれを参照する名前空間を定義することです。utilsただし、モジュールは呼び出されませんGame.utilsが、Gameそれにリンクするプロパティが表示されます。

/**
 * @namespace Game
 * @property {module:utils} utils
 */

/**
* @module utils
*/

/**
 * Create a matrix
 * @class
 */
function Matrix(){}
于 2015-04-08T16:55:57.353 に答える