javascript變量名和函數對象的命名規范是什么?
javascript命名規范沒有明確的定義吧,主要怎么命名讓自己看起來爽,團隊看起來爽,所以主要還是看你們自己怎么約定的。
命名規范
1.變量名稱 必須為 小寫字母。
2.類的命名使用駱駝命名規則,例如:
Account, EventHandler
3.常量 必須 在對象(類)或者枚舉變量的前部聲明。枚舉變量的命名必須要有實際的意義,并且其成員 必須 使用駱駝命名規則或使用大寫:
var NodeTypes ={ Element :1, DOCUMENT:2}
4.簡寫單詞 不能使用 大寫名稱作為變量名:
getInnerHtml(), getXml(), XmlDocument
5.方法的命令 必須 為動詞或者是動詞短語:
obj.getSomeValue()
6.公有類的命名 必須 使用混合名稱(mixedCase)命名。
7.CSS 變量的命名 必須 使用其對應的相同的公共類變量。
8.私有類的變量屬性成員 必須 使用混合名稱(mixedCase)命名,并前面下下劃線(_)。例如:
var MyClass =function(){ var _buffer; this.doSomething=function(){ };
}
9.變量如果設置為私有,則前面 必須 添加下劃線。
this._somePrivateVariable = statement;
10.通用的變量 必須 使用與其名字一致的類型名稱:
setTopic(topic)// 變量 topic 為 Topic 類型的變量
11.所有的變量名 必須 使用英文名稱。
12.變量如有較廣的作用域(large scope),必須使用全局變量;此時可以設計成一個類的成員。相對的如作用域較小或為私有變量則使用簡潔的單詞命名。
13.如果變量有其隱含的返回值,則避免使用其相似的方法:
getHandler();// 避免使用 getEventHandler()
14.公有變量必須清楚的表達其自身的屬性,避免字義含糊不清,例如:
MouseEventHandler
,而非 MseEvtHdlr。 請再次注意這條規定,這樣做得的好處是非常明顯的。它能明確的表達表達式所定義的含義。
15.類/構造函數 可以使用 擴展其基類的名稱命名,這樣可以正確、迅速的找到其基類的名稱: EventHandler UIEventHandler MouseEventHandler 基類可以在明確描述其屬性的前提下,縮減其命名: MouseEventHandler as opposed to MouseUIEventHandler.
特殊命名規范
術語 “get/set” 不要和一個字段相連,除非它被定義為私有變量。前面加 “is” 的變量名 應該 為布爾值,同理可以為 “has”, “can” 或者 “should”。
術語 “compute” 作為變量名應為已經計算完成的變量。
術語 “find” 作為變量名應為已經查找完成的變量。
術語 “initialize” 或者 “init” 作為變量名應為已經實例化(初始化)完成的類或者其他類型的變量。UI (用戶界面)控制變量應在名稱后加控制類型,例如: leftComboBox, TopScrollPane。復數必須有其公共的名稱約定(原文:Plural form MUST be used to name collections)。帶有 “num” 或者 “count” 開頭的變量名約定為數字(對象)。重復變量建議使用 “i”, “j”, “k” (依次類推)等名稱的變量。補充用語必須使用補充詞,例如: get/set, add/remove, create/destroy, start/stop, insert/delete, begin/end, etc.能縮寫的名稱盡量使用縮寫。避免產生歧義的布爾變量名稱,例如: isNotError, isNotFound 為非法錯誤類建議在變量名稱后加上 “Exception” 或者 “Error”。方法如果返回一個類,則應該在名稱上說明返回什么;如果是一個過程,則應該說明做了什么。