javascript - 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-toolkit (jsdoc2) とは異なります。

次の例は、Michael jsdoc と 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() {
   }
});