javascript - JSDoc：模块和命名空间之间的关系是什么

Question

我在理解联合中命名空间和模块的目的时遇到了问题。例如我有一堂课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没有Game命名空间前缀，如果我点击Game链接，它不包含utils模块链接。

此外，我无法向该模块添加另一个类，因为该类未显示在utils模块选项卡中：

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

问题是：记录命名空间和模块的正确方法是什么？它们各自的用例是什么？

score 6 · Accepted Answer

我玩了一下，我想在命名空间中包含模块有点棘手。对我有用的是定义一个模块utils和一个引用它的命名空间。但是，该模块被调用utils，Game.utils但Game您可以看到链接到它的属性。

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

/**
* @module utils
*/

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

1 回答 1