前言
相當不錯的 Javascript 編程風格規(guī)范,建議大家采用此規(guī)范編寫 Javascript。原文鏈接: http://dojotoolkit.org/developer/StyleGuide 。
翻譯(Translated by):feelinglucky{at}gmail.com,轉(zhuǎn)載請注明出處、作者和翻譯者,謝謝配合。
本文地址: http://code.google.com/p/grace/wiki/DojoStyle 。
序
Any violation to this guide is allowed if it enhances readability.
所有的代碼都要變成可供他人容易閱讀的。
快讀參考
核心 API 請使用下面的風格:
結(jié)構(gòu) |
規(guī)則 |
注釋 |
模塊 |
小寫 |
不要使用多重語義(Never multiple words) |
類 |
駱駝 |
|
公有方法 |
混合 |
其他的外部調(diào)用也可以使用 lower_case(),這樣的風格 |
公有變量 |
混合 |
|
常量 |
駱駝 或 大寫 |
下面的雖然不是必要的,但建議使用:
結(jié)構(gòu) |
規(guī)則 |
私有方法 |
混合,例子:_mixedCase |
私有變量 |
混合,例子:_mixedCase |
方法(method)參數(shù) |
混合,例子:_mixedCase, mixedCase |
本地(local)變量 |
混合,例子:_mixedCase, mixedCase |
命名規(guī)范
- 變量名稱 必須為 小寫字母。
- 類的命名使用駱駝命名規(guī)則,例如:
Account, EventHandler
- 常量 必須 在對象(類)或者枚舉變量的前部聲明。枚舉變量的命名必須要有實際的意義,并且其成員 必須 使用駱駝命名規(guī)則或使用大寫:
var NodeTypes = { Element : 1, DOCUMENT: 2 }
- 簡寫單詞 不能使用 大寫名稱作為變量名:
getInnerHtml(), getXml(), XmlDocument
- 方法的命令 必須 為動詞或者是動詞短語:
obj.getSomeValue()
- 公有類的命名 必須 使用混合名稱(mixedCase)命名。
- CSS 變量的命名 必須 使用其對應的相同的公共類變量。
- 私有類的變量屬性成員 必須 使用混合名稱(mixedCase)命名,并前面下下劃線(_)。例如:
var MyClass = function(){ var _buffer; this.doSomething = function(){ }; }
- 變量如果設置為私有,則前面 必須 添加下劃線。
this._somePrivateVariable = statement;
- 通用的變量 必須 使用與其名字一致的類型名稱:
setTopic(topic) // 變量 topic 為 Topic 類型的變量
- 所有的變量名 必須 使用英文名稱。
- 變量如有較廣的作用域(large scope),必須使用全局變量;此時可以設計成一個類的成員。相對的如作用域較小或為私有變量則使用簡潔的單詞命名。
- 如果變量有其隱含的返回值,則避免使用其相似的方法:
getHandler(); // 避免使用 getEventHandler()
- 公有變量必須清楚的表達其自身的屬性,避免字義含糊不清,例如:
MouseEventHandler,而非 MseEvtHdlr 請再次注意這條規(guī)定,這樣做得的好處是非常明顯的。它能明確的表達表達式所定義的含義。例如: dojo.events.mouse.Handler // 而非 dojo.events.mouse.MouseEventHandler
- 類/構(gòu)造函數(shù) 可以使用 擴展其基類的名稱命名,這樣可以正確、迅速的找到其基類的名稱:
EventHandler UIEventHandler MouseEventHandler 基類可以在明確描述其屬性的前提下,縮減其命名: MouseEventHandler as opposed to MouseUIEventHandler.
出處:藍色理想
責任編輯:moby
上一頁 下一頁 Dojo Javascript 編程規(guī)范 [2]
◎進入論壇網(wǎng)絡編程版塊參加討論
|