Dojo Javascript 编程规范.doc

DojoJavascript编程规范
前言
相当不错的Javascript编程风格规范，建议大家采用此规范编写Javascript。原文链接：HYPERLINK"http://dojotoolkit.org/developer/StyleGuide"http://dojotoolkit.org/developer/StyleGuide。
翻译（Translatedby）：feelinglucky{at}gmail.com，转载请注明出处、作者和翻译者，谢谢配合。
本文地址：HYPERLINK"http://code.google.com/p/grace/wiki/DojoStyle"http://code.google.com/p/grace/wiki/DojoStyle。
序
Anyviolationtothisguideisallowedifitenhancesreadability.
所有的代码都要变成可供他人容易阅读的。
快读参考
核心API请使用下面的风格：
结构规则注释模块小写不要使用多重语义（Nevermultiplewords）类骆驼公有方法混合其他的外部调用也可以使用lower_case()，这样的风格公有变量混合常量骆驼或大写下面的虽然不是必要的，但建议使用：
结构规则私有方法混合，例子：_mixedCase私有变量混合，例子：_mixedCase方法（method）参数混合，例子：_mixedCase,mixedCase本地（local）变量混合，例子：_mixedCase,mixedCase命名规范
变量名称必须为小写字母。
类的命名使用骆驼命名规则，例如：
Account,EventHandler
常量必须在对象（类）或者枚举变量的前部声明。枚举变量的命名必须要有实际的意义，并且其成员必须使用骆驼命名规则或使用大写：
varNodeTypes={Element:1,DOCUMENT:2}
简写单词不能使用大写名称作为变量名：
getInnerHtml(),getXml(),XmlDocument
方法的命令必须为动词或者是动词短语：
obj.getSomeValue()
公有类的命名必须使用混合名称（mixedCase）命名。
CSS变量的命名必须使用其对应的相同的公共类变量。
私有类的变量属性成员必须使用混合名称（mixedCase）命名，并前面下下划线（_）。例如：
varMyClass=function(){var_buffer;this.doSomething=function(){};}
变量如果设置为私有，则前面必须添加下划线。
this._somePrivateVariable=statement;
通用的变量必须使用与其名字一致的类型名称：
setTopic(topic)//变量topic为Topic类型的变量
所有的变量名必须使用英文名称。
变量如有较广的作用域（largescope），必须使用全局变量；此时可以设计成一个类的成员。相对的如作用域较小或为私有变量则使用简洁的单词命名。
如果变量有其隐含的返回值，则避免使用其相似的方法：
getHandler();//避免使用getEventHandler()
公有变量必须清楚的表达其自身的属性，避免字义含糊不清，例如：
MouseEventHandler，而非MseEvtHdlr。
请再次注意这条规定，这样做得的好处是非常明显的。它能明确的表达表达式所定义的含义。例如：
dojo.events.mouse.Handler//而非dojo.events.mouse.MouseEventHandler
类/构造函数可以使用扩展其基类的名称命名，这样可以正确、迅速的找到其基类的名称：
EventHandlerUIEventHandlerMouseEventHandler
基类可以在明确描述其属性的前提下，缩减其命名：
MouseEventHandlerasopposedtoMouseUIEventHandler.
特殊命名规范
术语"get/set"不要和一个字段相连，除非它被定义为私有变量。
前面加"is"的变量名应该为布尔值，同理可以为"has","can"或者"should"。
术语"compute"作为变量名应为已经计算完成的变量。
术语"find"作为变量名应为已经查找完成的变量。
术语"initialize"或者"init"作为变量名应为已经实例化（初始化）完成的类或者其他类型的变量。
UI（用户界面）控制变量应在名称后加控制类型，例如：leftComboBox,TopScrollPane。
复数必须有其公共的名称约定（原文：PluralformMUSTbeusedtonamecollections）。
带有"num