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

时间:2011-08-26 15:31:16

标签: javascript jsdoc

如何使用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();

1 个答案:

答案 0 :(得分:8)

此功能在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() {
   }
});