2015-04-04 52 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

相關問題