How to document namespaces in JavaScript?

Question

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

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

Lea Hayes · Accepted Answer · 2011-08-27 15:35:24Z

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() {
   }
});

answered Aug 27, 2011 at 15:35

Lea Hayes

64.5k16 gold badges69 silver badges119 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to document namespaces in JavaScript?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related