jsdoc - How to document namespaces in JavaScript? - Stack Overflow

admin管理员组

文章数量:1323023

How can namespaces be documented in JavaScript with jsDoc?

Here is my attempt, is this right?

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

Just to clarify, the above is used as follows:

my.namespace.foo();

How can namespaces be documented in JavaScript with jsDoc?

Here is my attempt, is this right?

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

Just to clarify, the above is used as follows:

my.namespace.foo();

• javascript
• jsdoc

Share Improve this question Follow asked Aug 26, 2011 at 15:31 Lea HayesLea Hayes 64.2k1616 gold badges6969 silver badges118118 bronze badges 1

• I know this is really old, but i am curious. Is $namespace something custom of yours? – j_walker_dev Commented Jan 5, 2015 at 10:17

Add a ment  | 

1 Answer 1

Sorted by: Reset to default 8

This feature is available in jsdoc3 micmath/jsdoc. The syntax of jsdoc3 is different to jsdoc-toolkit (jsdoc2)

The following example was by 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() {
   }
});

本文标签： jsdocHow to document namespaces in JavaScriptStack Overflow