Web技术中心代码规范.docVIP

Web技术中心代码规范 前言 软件的长期价值直接源于其编码质量。在它的整个生命周期里，一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征，那就能减少在以后对其进行修改时出错的可能性，编程规范可以帮助程序员们增加程序的健壮性。基本所有的前端代码都是暴露给公众的，所以我们更应该保证其质量。 规范理念 Any violation to this guide is allowed if it enhances readability. 所有的代码都要变成可供他人容易阅读的。 --引用自Dojo Javascript 语法规范 规范详解 命名规范 必须使用 Tab 键进行代码缩进，以节约代码大小建议设置编辑器的tab为4个空格的宽度（而不是4个空格） 接口风格 结构 规则 例如 类 驼峰式 ModuleClass() 公有方法 混合式 getPosition() 公有变量 混合式 frameStyle 常量 大写式 DEFAULT_FRAME_LAYOUT 其他建议风格，非必要 结构 规则 公有方法和属性 混合，例子：mixedCase 私有方法和 混合，例子：_mixedCase 方法（method）参数 混合，例子：mixedCase 本地（local）变量 混合，例子：mixedCase 所有语句结束后，必须使用 ; 号结束 所有变量必须是有意义的英文，严厉禁止拼音 变量允许使用公认英文缩写 类命名必须是驼峰式 常量必须所有单词大写，并且每个单词间加下划线 枚举类型时，枚举的命名必须有意义，枚举与枚举成员必须以驼峰式 常量和枚举必须在最前端定义，merge 时注意，必须把常量与枚举定义的文件放在文件列表的第一位 变量内的简写单词mlDocument，如果不在开头则全大写：loadXML！！！ on只能用作事件的命名 函数开头必须是有意义的动词或动词短语 私有类的变量属性成员 建议 使用混合式命名，并前面下下划线 临时的全局变量放到一个全局的哈希表里，方便变量回收 所有全局变量必须初始化，尽量少用全局变量 大括号前面不能有换行符 保留字以及特有的dom属性不能作为变量名 特殊命名约定 前面加 “is” 的变量名应该为布尔值，亦可使用 “can” “has” “should” 前面加 ”str” 的变量名应该为字符串 前面加 “arr” 的变量名应该为数组 前面加 “num” 或 “count” 的变量名应该为数字 “o” 作为局部变量或参数，表示为Object “e” 作为局部变量或参数，表示为Element “evt” 作为局部变量或参数，表示为event “err” 作为局部变量或参数，表示为error 重复变量建议使用 i, j, k （依次类推）等名称的变量(全世界公认) 能缩写的单词尽量缩写 避免产生令人误解的布尔值 isNotNumber isNan 处理错误的变量，必须在后面跟着 “Error” 初始化用的函数 必须使用 “init” 开头，如果一个页面只有初始化可以单独使用 init() 尽量做有意义的代码折行，不要让一行代码过长。(HTML 字符串除外) 操作符 建议 使用空格隔开 函数调用和方法 避免 使用空白 逗号（,） 建议 使用空白隔开。 不允许频繁使用 previousSibling 和 nextSibling 词法结构 普通代码段应该看起来如下： while(!isDone){ doSomething(); isDone = moreToDo();} 如下： var a = null, b = 1, c = 0; var funcA = function(){ var a = 0; ...} if 语句应该看起来像这样： if(someCondition){ statements;}else if(someOtherCondition){ statements;}else{ statements;} for 语句应该看起来像这样： for(initialization; condition; update){ statements;} while 语句应该看起来像这样： while(!isDone){ doSomething(); isDone = moreToDo();} do ... while 语句应该看起来像这样： do{ statements;}while(condition); switch 语句应该看起来像这样： switch(condition){ case A:  statements; //注释 case B:  statements; break; defa