logo资料库

Google JavaScript 编码规范指南.doc

发布时间：2022-07-02 发布人：admin 分类：说明书 资料大小：0.29M 资料格式：doc 举报 版权申诉
第1页 / 共40页
第2页 / 共40页
第3页 / 共40页
第4页 / 共40页
第5页 / 共40页
第6页 / 共40页
第7页 / 共40页
第8页 / 共40页
资料共40页，剩余部分请下载后查看
    Google JavaScript 编码规范指南
    重要注意事项
    显示被隐藏的内容
    背景
    JavaScript 语言规范
    变量
    常量
    分号
    嵌套函数
    块内函数声明
    异常
    自定义异常
    标准特性
    封装基本类型
    多级原型结构
    方法定义
    闭包
    eval()
    with() {}
    this
    for-in 循环
    关联数组
    多行字符串
    Array 和 Object 直接量
    修改内置对象的原型
    IE下的条件注释
    JavaScript 编码风格
    命名
    自定义 toString() 方法
    延迟初始化
    明确作用域
    代码格式化
    括号
    字符串
    可见性 (私有域和保护域)
    JavaScript 类型
    注释
    编译
    Tips and Tricks
    Parting Words
    Google JavaScript 编码规范指南 修订版: 2.9 Aaron Whyte Bob Jervis Dan Pupius Eric Arvidsson Fritz Schneider Robby Walker 目录 JavaScript 语言规范 JavaScript 编码风格 重要注意事项 显示被隐藏的内容 link ▽ 变量 常量 分号 嵌套函数 块内函数声明 异常自定义异常 标准特性 封装基本类型 多级原型结构方法定义 闭包 eval() with() {} this for-in 循环关联数组 多行字符串 Array 和 Object 直接量修改 内置对象的原型 IE 下的条件注释 命名 自定义 toString() 方法 延迟初始化 明确作用域代码格式化 括 号 字符串 可见性 (私有域和保护域)JavaScript 类型 注释 编译 Tips and Tricks 这份指南中, 可以点击旁边的按钮来显示更多的细节. Hooray! 这里是更多详细的内容, 你也可以点击最上面的”显示/隐藏全部按钮”来切换显示更多内容. 背景 JavaScript 是一种客户端脚本语言, Google 的许多开源工程中都有用到它. 这份指南列出了编写 JavaScript 时需要遵守的规则. JavaScript 语言规范 变量 link ▽ 声明变量必须加上 var 关键字. Decision: 当你没有写 var, 变量就会暴露在全局上下文中, 这样很可能会和现有变量冲突. 另外, 如果没有加上, 很难明确该变量的作用域是什么, 变量也很可能像在局部作用域中, 很轻易地泄漏到 Document 或者 Window 中, 所以务必用 var 去声明变量. 常量 link ▽ 常量的形式如: NAMES_LIKE_THIS, 即使用大写字符, 并用下划线分隔. 你也可用 @const 标记来指明它是一个常量. 但请永远不要使用 const 关键词.
    Decision: 对于基本类型的常量, 只需转换命名. /** * The number of seconds in a minute. * @type {number} */ goog.example.SECONDS_IN_A_MINUTE = 60; 对于非基本类型, 使用 @const 标记. /** * The number of seconds in each of the given units. * @type {Object.} * @const */ goog.example.SECONDS_TABLE = { minute: 60, hour: 60 * 60, day: 60 * 60 * 24 } 这标记告诉编译器它是常量. 至于关键词 const, 因为 IE 不能识别, 所以不要使用. 分号 link ▽ 总是使用分号. 如果仅依靠语句间的隐式分隔, 有时会很麻烦. 你自己更能清楚哪里是语句的起止. 而且有些情况下, 漏掉分号会很危险: // 1. MyClass.prototype.myMethod = function() { return 42; } // No semicolon here. (function() { // Some initialization code wrapped in a function to create a scope for locals. })(); var x = { 'i': 1, 'j': 2 } // No semicolon here. // 2. Trying to do one thing on Internet Explorer and another on Firefox. // I know you'd never write code like this, but throw me a bone. [normalVersion, ffVersion][isIE](); var THINGS_TO_EAT = [apples, oysters, sprayOnCheese] // No semicolon here.
    // 3. conditional execution a la bash -1 == resultOfOperation() || die(); 这段代码会发生些什么诡异事呢? 1. 报 JavaScript 错误 – 例子 1 上的语句会解释成, 一个函数带一匿名函数作为参数而被调用, 返 回 42 后, 又一次被”调用”, 这就导致了错误. 2. 例子 2 中, 你很可能会在运行时遇到 ‘no such property in undefined’ 错误, 原因是代码试图这 样 x[ffVersion][isIE]() 执行. 当 resultOfOperation() 返回非 NaN 时, 就会调用 die, 其结果也会赋给 THINGS_TO_EAT. 3. 为什么? JavaScript 的语句以分号作为结束符, 除非可以非常准确推断某结束位置才会省略分号. 上面的几个例子 产出错误, 均是在语句中声明了函数/对象/数组直接量, 但 闭括号(‘}’或’]')并不足以表示该语句的结束. 在 JavaScript 中, 只有当语句后的下一个符号是后缀或括号 运算符时, 才会认为该语句的结束. 遗漏分号有时会出现很奇怪的结果, 所以确保语句以分号结束. 嵌套函数 link ▽ 可以使用 嵌套函数很有用, 比如,减少重复代码, 隐藏帮助函数, 等. 没什么其他需要注意的地方, 随意使用. 块内函数声明 link ▽ 不要在块内声明一个函数 不要写成: if (x) { function foo() {} } 虽然很多 JS 引擎都支持块内声明函数, 但它不属于 ECMAScript 规范 (见 ECMA-262, 第 13 和 14 条). 各个浏览器糟糕的实现相互不兼容, 有些也与未来 ECMAScript 草案相违背. ECMAScript 只允许在脚本 的根语句或函数中声明函数. 如果确实需要在块中定义函数, 建议使用函数表达式来初始化变量: if (x) { var foo = function() {} } 异常 link ▽ 可以 你在写一个比较复杂的应用时, 不可能完全避免不会发生任何异常. 大胆去用吧.
    自定义异常 link ▽ 可以 有时发生异常了, 但返回的错误信息比较奇怪, 也不易读. 虽然可以将含错误信息的引用对象或者可能产 生错误的完整对象传递过来, 但这样做都不是很好, 最好还是自定义异常类, 其实这些基本上都是最原始 的异常处理技巧. 所以在适当的时候使用自定义异常. 标准特性 link ▽ 总是优于非标准特性. 最大化可移植性和兼容性, 尽量使用标准方法而不是用非标准方法, (比如, 优先用 string.charAt(3) 而不用 string[3] , 通过 DOM 原生函数访问元素, 而不是使用应用封装好的快速接口. 封装基本类型 link ▽ 不要 没有任何理由去封装基本类型, 另外还存在一些风险: var x = new Boolean(false); if (x) { alert('hi'); // Shows 'hi'. } 除非明确用于类型转换, 其他情况请千万不要这样做！ var x = Boolean(0); if (x) { alert('hi'); // This will never be alerted. } typeof Boolean(0) == 'boolean'; typeof new Boolean(0) == 'object'; 有时用作 number, string 或 boolean 时, 类型的转换会非常实用. 多级原型结构 link ▽ 不是首选 多级原型结构是指 JavaScript 中的继承关系. 当你自定义一个 D 类, 且把 B 类作为其原型, 那么这就获得 了一个多级原型结构. 这些原型结构会变得越来越复杂! 使用
    the Closure 库 中的 goog.inherits() 或其他类似的用于继承的函数, 会是更好的选择. function D() { goog.base(this) } goog.inherits(D, B); D.prototype.method = function() { ... }; 方法定义 link ▽ Foo.prototype.bar = function() { ... }; 有很多方法可以给构造器添加方法或成员, 我们更倾向于使用如下的形式: Foo.prototype.bar = function() { /* ... */ }; 闭包 link ▽ 可以, 但小心使用. 闭包也许是 JS 中最有用的特性了. 有一份比较好的介绍闭包原理的文档. 有一点需要牢记, 闭包保留了一个指向它封闭作用域的指针, 所以, 在给 DOM 元素附加闭包时, 很可能 会产生循环引用, 进一步导致内存泄漏. 比如下面的代码: function foo(element, a, b) { element.onclick = function() { /* uses a and b */ }; } 这里, 即使没有使用 element, 闭包也保留了 element, a 和 b 的引用, . 由于 element 也保留了对闭包的引用, 这就产生了循环引用, 这就不能被 GC 回收. 这种情况下, 可将代码重构为: function foo(element, a, b) { element.onclick = bar(a, b); } function bar(a, b) { return function() { /* uses a and b */ } } eval()
    link ▽ 只用于解析序列化串 (如: 解析 RPC 响应) eval() 会让程序执行的比较混乱, 当 eval() 里面包含用户输入的话就更加危险. 可以用其他更佳的, 更清晰, 更安全的方式写你的代码, 所以一般情况下请不要使用 eval(). 当碰到一些需要解析序列化串的情况下(如, 计算 RPC 响应), 使用 eval 很容易实现. 解析序列化串是指将字节流转换成内存中的数据结构. 比如, 你可能会将一个对象输出成文件形式: users = [ { name: 'Eric', id: 37824, email: 'jellyvore@myway.com' }, { name: 'xtof', id: 31337, email: 'b4d455h4x0r@google.com' }, ... ]; 很简单地调用 eval 后, 把表示成文件的数据读取回内存中. 类似的, eval() 对 RPC 响应值进行解码. 例如, 你在使用 XMLHttpRequest 发出一个 RPC 请求后, 通过 eval () 将服务端的响应文本转成 JavaScript 对象: var userOnline = false; var user = 'nusrat'; var xmlhttp = new XMLHttpRequest(); xmlhttp.open('GET', 'http://chat.google.com/isUserOnline?user=' + user, false); xmlhttp.send(''); // Server returns: // userOnline = true; if (xmlhttp.status == 200) { eval(xmlhttp.responseText); } // userOnline is now true. with() {} link ▽ 不要使用 使用 with 让你的代码在语义上变得不清晰. 因为 with 的对象, 可能会与局部变量产生冲突, 从而改变你 程序原本的用义. 下面的代码是干嘛的? with (foo) {
    var x = 3; return x; } 答案: 任何事. 局部变量 x 可能被 foo 的属性覆盖, 当它定义一个 setter 时, 在赋值 3 后会执行很多其他 代码. 所以不要使用 with 语句. this link ▽ 仅在对象构造器, 方法, 闭包中使用. this 的语义很特别. 有时它引用一个全局对象(大多数情况下), 调用者的作用域(使用 eval 时), DOM 树中的节点(添加事件处理函数时), 新创建的对象(使用一个构造器), 或者其他对象(如果 函数被 call() 或 apply()). 使用时很容易出错, 所以只有在下面两个情况时才能使用:   for-in 循环 对象的方法(包括创建的闭包)中 在构造器中 link ▽ 只用于 object/map/hash 的遍历 对 Array 用 for-in 循环有时会出错. 因为它并不是从 0 到 length - 1 进行遍历, 而是所有出现在对象及其原型链的键值. 下面就是一些失败的使用案例: function printArray(arr) { for (var key in arr) { print(arr[key]); } } printArray([0,1,2,3]); // This works. var a = new Array(10); printArray(a); // This is wrong. a = document.getElementsByTagName('*'); printArray(a); // This is wrong. a = [0,1,2,3]; a.buhu = 'wine'; printArray(a); // This is wrong again. a = new Array;
    a[3] = 3; printArray(a); // This is wrong again. 而遍历数组通常用最普通的 for 循环. function printArray(arr) { var l = arr.length; for (var i = 0; i < l; i++) { print(arr[i]); } } 关联数组 link ▽ 永远不要使用 Array 作为 map/hash/associative 数组. 数组中不允许使用非整型作为索引值, 所以也就不允许用关联数组. 而取代它使用 Object 来表示 map/hash 对象. Array 仅仅是扩展自 Object (类似于其他 JS 中的对象, 就像 Date, RegExp 和 String)一样来使用. 多行字符串 link ▽ 不要使用 不要这样写长字符串: var myString = 'A rather long string of English text, an error message \ actually that just keeps going and going -- an error \ message to make the Energizer bunny blush (right through \ those Schwarzenegger shades)! Where was I? Oh yes, \ you\'ve got an error and all the extraneous whitespace is \ just gravy. Have a nice day.'; 在编译时, 不能忽略行起始位置的空白字符; “\” 后的空白字符会产生奇怪的错误; 虽然大多数脚本引擎支 持这种写法, 但它不是 ECMAScript 的标准规范. Array 和 Object 直接量 link ▽ 使用 使用 Array 和 Object 语法, 而不使用 Array 和 Object 构造器. 使用 Array 构造器很容易因为传参不恰当导致错误. // Length is 3. var a1 = new Array(x1, x2, x3); // Length is 2.
    分享到：
    赞 收藏

    相关推荐

    资料库

    前端

    共收录66份资料，累计5个分类，关注成员有19位，主要包括：Swift,Webpack,Node.js,Actionscript,Javascript

    热门标签

    Swift Webpack Node.js Actionscript Javascript

    最新资料