जावास्क्रिप्ट में नेमस्पेस कैसे दस्तावेज़ करें?

Question

जावास्क्रिप्ट में jsDoc के साथ नेमस्पेस को कैसे दस्तावेज़ित किया जा सकता है?

मेरा प्रयास है, क्या यह सही है?

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

बस स्पष्ट करने के लिए, इस प्रकार ऊपर प्रयोग किया जाता है:

my.namespace.foo(); 

Answer 1

यह सुविधा jsdoc3 micmath/jsdoc में उपलब्ध है। jsdoc3 की वाक्य रचना jsdoc-टूलकिट (jsdoc2)

निम्न उदाहरण माइकल 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() { 
    } 
});