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

标签 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();

最佳答案

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

关于javascript - 如何在 JavaScript 中记录命名空间?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/7207106/

相关文章:

javascript - 在此代码示例中 "this"到底意味着什么?

对象字面量中的 JSDoc 引用函数(CommonJS module.exports)

javascript - jsdoc 如何使用静态属性的类

jsdoc - "valid"JSDoc 是否需要星号?

documentation - 通过 "doc"解释源代码?

javascript - 使文件输入成为 href

javascript - 小数值的固定条件

javascript - CoffeeScript 中循环指针的增量

javascript - 在socket.io范围之外使用var

javascript - JsDoc 命名空间