6

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

1 回答 1

8

此功能在 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() {
   }
});
于 2011-08-27T15:35:24.123 回答