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

Question

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

这是我的尝试，是否正确？

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

仅作澄清，上述用法如下：

my.namespace.foo();

- Lea Hayes

---

我知道这个问题很老了，但我很好奇。$namespace 是你自己定义的吗？ - j_walker_dev

Answer 1

这个功能可在jsdoc3 micmath/jsdoc中使用。jsdoc3的语法与jsdoc-toolkit(jsdoc2)不同。

下面的例子是由Michael jsdoc和伪命名空间?提供的。

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

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

- Lea Hayes