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(){}

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

Answer 1

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

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

/**
* @module utils
*/

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