2015-04-04 54 views
0

使用YUIDoc(或类似的服务),传统的方式来记录下面的全局对象是什么?什么是传统的文件全局JavaScript对象的方式?

var Variables = { 
    var var1 = "foo", 
    var var2 = "bar" 
}; 

是不是@class?它似乎并不如此,因为其中没有构造函数。但如果它不是一个班级,它是什么?

另外,将Variables大写为“合适”?还是只保留用于构造函数?

回答

0

这可能取决于您打算如何使用此对象。 (你的语法是无效的,顺便说一句。)假设你打算使用它作为一个枚举常量,那么也许是这样的:

/** 
* Describe it here... 
* 
* @property VARIABLE_NAME 
* @type Object 
* @static 
* @final 
*/ 
var VARIABLE_NAME = { 
    var1: "foo", 
    var2: "bar" 
} 

参考:http://yui.github.io/yuidoc/syntax/index.html

+0

但根据文件,属性必须是部分类。这意味着成为一个全球性的对象。这不会对您的解决方案造成问题吗? (感谢您的答复)。 – George 2015-04-04 16:16:03

+0

你提出了一个好的观点。我看到这个(http://yuilibrary.com/forum-archive/forum/[email protected]=26&t=1532.html)旧线程,其中有人提出了类似的问题,并建议创建一个假的“GLOBAL”存储桶将这些属性与。我希望Yuidoc能够提出更优雅的解决方案,但目前我没有看到任何东西...... – brianvaughn 2015-04-04 16:20:19