From 5618f6e5e7bdbb8a84bf84741c18aded1004bb46 Mon Sep 17 00:00:00 2001 From: Ruan Yifeng Date: Tue, 3 Mar 2015 23:30:21 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=BB=BAstyle.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/function.md | 6 +- docs/reference.md | 1 + docs/string.md | 4 + docs/style.md | 241 ++++++++++++++++++++++++++++++++++++++++++++++ sidebar.md | 1 + 5 files changed, 251 insertions(+), 2 deletions(-) create mode 100644 docs/style.md diff --git a/docs/function.md b/docs/function.md index 4e97044..12f523e 100644 --- a/docs/function.md +++ b/docs/function.md @@ -54,8 +54,8 @@ log('Hello', '') // Hello ```javascript function Point(x = 0, y = 0) { - this.x = x; - this.y = y; + this.x = x; + this.y = y; } var p = new Point(); @@ -63,6 +63,8 @@ var p = new Point(); ``` +除了简洁，ES6的写法还有两个好处：首先，阅读代码的人，可以立刻意识到哪些参数是可以省略的，不用查看函数体或文档；其次，有利于将来的代码优化，即使未来的版本彻底拿到这个参数，也不会导致以前的代码无法运行。 + 默认值的写法非常灵活，下面是一个为对象属性设置默认值的例子。 ```javascript diff --git a/docs/reference.md b/docs/reference.md index 78de7af..37d3935 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -23,6 +23,7 @@ - Guillermo Rauch, [ECMAScript 6](http://rauchg.com/2015/ecmascript-6/) - Charles King, [The power of ECMAScript 6](http://charlesbking.com/power_of_es6/#/) - Benjamin De Cock, [Frontend Guidelines](https://github.com/bendc/frontend-guidelines): ES6最佳实践 +- Jani Hartikainen, [ES6: What are the benefits of the new features in practice?](http://codeutopia.net/blog/2015/01/06/es6-what-are-the-benefits-of-the-new-features-in-practice/) ## 语法点 diff --git a/docs/string.md b/docs/string.md index 4d878b7..740109d 100644 --- a/docs/string.md +++ b/docs/string.md @@ -535,11 +535,15 @@ tag`First line\nSecond line` 上面代码中，tag函数的第一个参数是一个数组`["First line\nSecond line"]`，这个数组有一个raw属性，等于`["First line\\nSecond line"]`，两者唯一的区别就是斜杠被转义了。 +```javascript + function tag(strings) { console.log(strings.raw[0]); // "First line\\nSecond line" } +``` + ## String.raw() String.raw方法，往往用来充当模板字符串的处理函数，返回字符串被转义前的原始格式。 diff --git a/docs/style.md b/docs/style.md new file mode 100644 index 0000000..fc631dd --- /dev/null +++ b/docs/style.md @@ -0,0 +1,241 @@ +# 编程风格 + +本章探讨如何将ES6的新语法，运用到编码实践之中，与传统的JavaScript语法结合在一起，以及如何形成良好的编码风格。 + +## 块级作用域 + +**（1）let取代var** + +ES6提出了两个新的声明变量的命令：let和const。其中，let完全可以取代var，因为两者语义相同，而且let没有副作用。 + +```javascript + +"use strict"; + +if(true) { + let x = 'hello'; +} + +for (let i = 0; i < 10; i++) { + console.log(i); +} + +``` + +上面代码如果用var替代let，实际上就声明了一个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效，var命令做不到这一点。 + +var命令存在变量提升效用，let命令没有这个问题。 + +```javascript + +"use strict"; + +if(true) { + console.log(x); // ReferenceError + let x = 'hello'; +} + +``` + +上面代码如果使用var替代let，console.log那一行就不会报错，而是会输出undefined，因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。 + +所以，建议不再使用var命令，而是使用let命令取代。 + +**（2）全局常量和线程安全** + +在let和const之间，建议优先使用const，尤其是在全局环境，不应该设置变量，只应设置常量。这符合函数式编程思想，有利于将来的分布式运算。 + +```javascript + +// bad +var a = 1, b = 2, c = 3; + +// good +const a = 1; +const b = 2; +const c = 3; + +// best +const [a, b, c] = [1, 2, 3]; + +``` + +const声明常量还有两个好处，一是阅读代码的人立刻会意识到不应该修改这个值，二是防止了无意间修改变量值所导致的错误。 + +所有的函数都应该设置为常量。 + +let表示的变量，只应出现在单线程运行的代码中，不能是多线程共享的，这样有利于保证线程安全。 + +**（3）严格模式** + +V8引擎只在严格模式之下，支持let和const。结合前两点，这实际上意味着，将来所有的编程都是针对严格模式的。 + +## 字符串 + +静态字符串一律使用单引号或反引号，不使用双引号。动态字符串使用反引号。 + +```javascript + +// bad +const a = "foobar"; +const b = 'foo' + a + 'bar'; + +// acceptable +const c = `foobar`; + +// good +const a = 'foobar'; +const b = `foo${a}bar`; +const c = 'foobar'; + +``` + +## 对象 + +单行定义的对象，最后一个成员不以逗号结尾。多行定义的对象，最后一个成员以逗号结尾。 + +```javascript + +// bad +const a = { k1: v1, k2: v2, }; +const b = { + k1: v1, + k2: v2 +}; + +// good +const a = { k1: v1, k2: v2 }; +const b = { + k1: v1, + k2: v2, +}; + +``` + +对象尽量静态化，一旦定义，就不得随意添加新的属性。如果添加属性不可避免，要使用Object.assign方法。 + +```javascript + +// bad +const a = {}; +a.x = 3; + +// if reshape unavoidable +const a = {}; +Object.assign(a, { x: 3 }); + +// good +const a = { x: null }; +a.x = 3; + +``` + +## 函数 + +使用匿名函数的场合，一律改为使用箭头函数。 + +```javascript + +// bad +arr.reduce(function(x, y) { return x + y; }, 0); + +// good +arr.reduce((x, y) => x + y, 0); + +``` + +箭头函数取代Function.prototype.bind，不应再用 self / _this / that 绑定 this。 + +```javascript + +// bad +const self = this; +const boundMethod = function(...params) { + return method.apply(self, params); +} + +// acceptable +const boundMethod = method.bind(this); + +// best +const boundMethod = (...params) => method.apply(this, params); + +``` + +所有配置项都应该集中在一个对象，放在最后一个参数，布尔值不可以直接作为参数。 + +```bash + +// bad +function divide(a, b, option = false ) { +} + +// good +function divide(a, b, { option = false } = {}) { +} + +``` + +## Map结构 + +注意区分Object和Map，只有模拟实体对象时，才使用Object。如果只是需要key:value的数据结构，使用Map。因为Map有内建的遍历机制。 + +```javascript + +let map = new Map(arr); + +for (let key of map.keys()) { + console.log(key); +} + +for (let value of map.values()) { + console.log(value); +} + +for (let item of map.entries()) { + console.log(item[0], item[1]); +} + +``` + +## 模块 + +使用import取代require。 + +```javascript +// bad +const moduleA = require('moduleA'); +const func1 = moduleA.func1; +const func2 = moduleA.func2; + +// good +import { func1, func2 } from 'moduleA'; +``` + +使用export取代module.exports。 + +```javascript + +// commonJS的写法 +var React = require('react'); + +var Breadcrumbs = React.createClass({ + render() { + return <nav />; + } +}); + +module.exports = Breadcrumbs; + +// ES6的写法 +import React from 'react'; + +const Breadcrumbs = React.createClass({ + render() { + return <nav />; + } +}); + +export default Breadcrumbs + +``` diff --git a/sidebar.md b/sidebar.md index b031a01..ce8d4ba 100644 --- a/sidebar.md +++ b/sidebar.md @@ -19,6 +19,7 @@ 1. [Generator函数](#docs/generator) 1. [Promise对象](#docs/promise) 1. [Class和Module](#docs/class) +1. [编程风格](#docs/style) 1. [参考链接](#docs/reference) ## 其他