jQuery编码规范文档.docVIP

上海来去网络信息科技有限公司 jQuery编码规范文档 文件状态 [ ] 草稿 [√] 正式发布 [ ] 正在修改 文件标识： RQ Report 当前版本： V 1.0 作 者： 陈冬明 完成日期： 2011-04-13 上海来去网络信息科技有限公司 版 本 历 史 版本/状态 作者 参与者 日 期 备 注 V 1.0 陈冬明 2011-04-13 目 录 1.前言 4 2.jQuery编码规范 4 2.1空格 4 2.2等价判断 4 2.3代码块 4 2.4函数调用 5 2.5数组和对象 6 2.6赋值 6 2.7类型检查 6 2.8正则表达式 6 2.9字符串 7 2.10节点 7 1.前言 本文档是jQuery客户端脚本语言编写的开发规范，适用于项目编码时作参考文献。 jQuery遵循javacript规范,更多关于javacript规范，请参见《Google-Javascript编码规范》。 jQuery文档开发规范官方英文版：/JQuery_Core_Style_Guidelines 2.jQuery编码规范jQuery核心模块的编码规范 javascript的语言语法。 空格使用tab进行缩进 代码中多用点空格 if(blah===foo){ foo(bar,baz,{zoo:1}); } 正确写法: if ( blah === foo ) { foo( bar, baz, {zoo: 1} ); } 2.1.3左花括号前面一定要有空格行内不要使用tabvar a = true, c = false, // yay b = false; // grrr 2.1.5空行不要有空格 行尾不要有空格 等价判断 尽量使用严格的等价判断符 ，尽量不用。 代码块 if/else/for/while/try要使用花括号，且要换行。 代码块一定要用花括号括起来： if ( true ) blah(); 正确写法: if ( true ) { blah(); } 2.3.3不要把语句和判断条件放在同一行：if ( true ) return; if ( true ) blah(); 正确写法: if ( true ) { return; } if ( true ) { blah(); } 2.3.4 else/else if/catch要和花括号在同一行： if ( blah ) { baz(); } else { baz2(); } 例外： else if 的情况， else 就不要加花括号了： } else if ( test ) { blah(); } // 没必要： } else { if ( test ) { blah(); } } 2.3.5不要使用三元操作符取代if/else语句。 不要使用 object object.method()取代 if/else 语句，除非在条件判断中。 函数调用 参数两边要加一个空格 foo( true ); foo( blah );例外：如果已经在函数调用中的话，里面的函数调用可以不加空格： foo( bar(true) ); 例外：函数，对象，数组字面量，如果是唯一参数的话，可以紧贴括号：foo(function() { }); foo([ ]); foo({ }); 2.4.2空函数调用不需要加空格：foo 2.4.3逗号和冒号后面一定要跟空格 数组和对象 空对象和数组不需要填入空格： 2.5.2逗号和冒号后面一定要跟空格 赋值 赋值语句一定要跟分号。 分号后面一定要换行。 类型检查 String: typeof object === stringNumber: typeof object === number Boolean: typeof object === boolean Object: typeof object === object Plain Object: jQuery.isPlainObject(object) Function: jQuery.isFunction(object) Array: jQuery.isArray(object) Element: object.nodeType null: object === null null or undefined: object == null undefined: 三种形式 Global Variables