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