JavaScriptで名前空間を文書化する方法は？

Question

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

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