如何在JavaScript中记录名称空间

How to document namespaces in JavaScript?

本文关键字：空间 记录 JavaScript      更新时间：2023-09-26

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

此功能在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() {
   }
});
相关文章：