如何在 JavaScript 中记录命名空间？答案

【问题标题】：How to document namespaces in JavaScript?如何在 JavaScript 中记录命名空间？
【发布时间】：2011-08-27 23:35:24
【问题描述】：

如何使用 jsDoc 在 JavaScript 中记录命名空间？

这是我的尝试，对吗？

/**
 * My special namespace
 *
 * @name my.namespace
 * @namespace
 */
$namespace('my.namespace', /** @lends my.namespace **/ {
    /**
     * Foo - does something really neat...
     * @function
     */
    foo: function() {
    }
});

为了澄清，上面的用法如下：

my.namespace.foo();

【问题讨论】：

我知道这真的很老了，但我很好奇。 $namespace 是你的习惯吗？

标签： javascript jsdoc

【解决方案1】：

此功能在 jsdoc3 micmath/jsdoc 中可用。 jsdoc3的语法与jsdoc-toolkit（jsdoc2）不同

以下示例由 Michael jsdoc and pseudo-namespaces?

/**
* Document me.
* @namespace my
*/

/**
* My special namespace
* @namespace my.namespace
*/
$namespace('my.namespace', /** @lends my.namespace **/ {
   /**
    * Foo - does something really neat...
    */
   foo: function() {
   }
});

【讨论】：