2011-08-26 4 views
6

Làm thế nào các không gian tên có thể được ghi lại bằng JavaScript với jsDoc?Làm cách nào để ghi lại không gian tên trong JavaScript?

Đây là nỗ lực của tôi, điều này có đúng không?

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

Chỉ cần làm rõ, bên trên được sử dụng như sau:

my.namespace.foo(); 
+0

Tôi biết điều này thực sự là cũ, nhưng tôi tò mò. Là '$ namespace' một cái gì đó tùy chỉnh của bạn? –

Trả lời

8

Tính năng này có sẵn trong jsdoc3 micmath/jsdoc. Cú pháp của jsdoc3 là khác nhau để jsdoc-toolkit (jsdoc2)

Ví dụ sau là 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() { 
    } 
});