JavaScript編程規范

1. 聲明(塊級作用域)

(1)let取代var

'use strict';

if (true) {
  let x = 'hello';
}

for (let i = 0; i < 10; i++) {
  console.log(i);
}
  • 上面代碼如果用var替代let,實際上就聲明了兩個全局變量,這顯然不是本意。變量應該只在其聲明的代碼塊內有效,var命令做不到這一點;var命令存在變量提升效用,let命令沒有這個問題
'use strict';

if (true) {
  console.log(x); // ReferenceError
  let x = 'hello';
}
  • 上面代碼如果使用var替代let,console.log那一行就不會報錯,而是會輸出undefined,因為變量聲明提升到代碼塊的頭部。這違反了變量先聲明后使用的原則。
  • 建議不再使用var命令,而是使用let命令取代

(2)全局常量和線程安全

  • const優于let有幾個原因:
    • const可以提醒閱讀程序的人,這個變量不應該改變
    • const比較符合函數式編程思想,運算不改變值,只是新建值,而且這樣也有利于將來的分布式運算
    • JavaScript 編譯器會對const進行優化,所以多使用const,有利于提高程序的運行效率,也就是說let和const的本質區別,其實是編譯器內部的處理不同
  • 所有的函數都應該設置為常量

2. 字符串

  • 靜態字符串一律使用單引號或反引號,不使用雙引號。動態字符串使用反引號。
// 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`;

3. 結構賦值

  • 使用數組成員對變量賦值時,優先使用解構賦值。
const arr = [1, 2, 3, 4, 5];

// bad
const first = arr[0];
const second = arr[1];

// good
const [first, second] = arr;
  • 函數的參數如果是對象的成員,優先使用解構賦值。
// bad 
function getFullName(user) {
    const firstName = user.firstName;
    const lastName = user.lastName;
}

// good
function getFullName(obj) {
    const { firstName, lastName } = obj;
}

// best
function getFullName({firstName,lastName}) {
    
}

4. 對象

  • 單行定義的對象,最后一個成員不以逗號結尾。多行定義的對象,最后一個成員以逗號結尾
// bed
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方法。
// bad
const a = {};
a.x = 3;

// if reshape unavoidable
const a = {};
Object.assign(a, {x: 2});

// good
const a = {x: null};
a.x = 3;
  • 對象的屬性和方法,盡量采用簡潔表達法,這樣易于描述和書寫
let ref = 'some value';

// bad
const atom = {
    ref: ref,
    value: 1,
    addValue: function (value) {
        return atom.value + vlaue
    },
};

// good
const atom = {
    ref,
    
    value: 1,
    
    addValue(value) {
        return atom.value + value
    }
}

5. 數組

  • 使用擴展運算符(...)拷貝數組
// bad
const len = items.length;
const itemsCopy = [];
let i;

for (i = 0; i < len; i++) {
  itemsCopy[i] = items[i];
}

// good
const itemsCopy = [...items];
  • 使用 Array.from 方法,將類似數組的對象轉為數組
const foo = document.querySelectorAll('.foo');
const nodes = Array.from(foo);

6. 函數

  • 立即執行函數可以寫成箭頭函數的形式
(() => {
    console.log('Welcome to the Internet.')
})();
  • 那些需要使用函數表達式的場合,盡量用箭頭函數代替。因為這樣更簡潔,而且綁定了 this
// bad
[1, 2, 3].map(function (x) {
  return x * x;  
});

// good
[1, 2, 3].map((x) => {
    return x * x;
});

// best
[1, 2, 3].map(x => x*x);
  • 箭頭函數取代Function.prototype.bind,不應再用 self/_this/that 綁定 this
// 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);
  • 所有配置項都應該集中在一個對象,放在最后一個參數,布爾值不可以直接作為參數
// bad
function divide(a, b, option = false ) {
}

// good
function divide(a, b, { option = false } = {}) {
}
  • 不要在函數體內使用 arguments 變量,使用 rest 運算符(...)代替。因為 rest 運算符顯式表明你想要獲取參數,而且 arguments 是一個類似數組的對象,而 rest 運算符可以提供一個真正的數組
// bad
function concatenateAll() {
  const args = Array.prototype.slice.call(arguments);
  return args.join('');
}

// good
function concatenateAll(...args) {
  return args.join('');
}
  • 使用默認值語法設置函數參數的默認值。
// bad
function handleThings(opts) {
  opts = opts || {};
}

// good
function handleThings(opts = {}) {
  // ...
}

7. Map 結構

  • 注意區分 Object 和 Map,只有模擬現實世界的實體對象時,才使用 Object。如果只是需要key: value的數據結構,使用 Map 結構。因為 Map 有內建的遍歷機制。
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],itme[1])
}

8. Class

  • 總是用 Class,取代需要 prototype 的操作。因為 Class 的寫法更簡潔,更易于理解
// bad
function Queue(contents = []) {
  this._queue = [...contents];
}
Queue.prototype.pop = function() {
  const value = this._queue[0];
  this._queue.splice(0, 1);
  return value;
}

// good
class Queue {
  constructor(contents = []) {
    this._queue = [...contents];
  }
  pop() {
    const value = this._queue[0];
    this._queue.splice(0, 1);
    return value;
  }
}
  • 使用extends實現繼承,因為這樣更簡單,不會有破壞instanceof運算的危險。
// bad
const inherits = require('inherits');
function PeekableQueue(contents) {
  Queue.apply(this, contents);
}
inherits(PeekableQueue, Queue);
PeekableQueue.prototype.peek = function() {
  return this._queue[0];
}

// good
class PeekableQueue extends Queue {
  peek() {
    return this._queue[0];
  }
}

9. 模塊

  • 首先,Module 語法是 JavaScript模塊的標準寫法,堅持使用這種寫法。使用import取代require。
// bad
const moduleA = require('moduleA');
const func1 = moduleA.func1;
const func2 = moduleA.func2;

// good
import { func1, func2 } from 'moduleA';
  • 使用export取代module.exports。
// commonJS的寫法
var React = require('react');

var Breadcrumbs = React.createClass({
  render() {
    return <nav />;
  }
});

module.exports = Breadcrumbs;

// ES6的寫法
import React from 'react';

class Breadcrumbs extends React.Component {
  render() {
    return <nav />;
  }
};

export default Breadcrumbs;
  • 如果模塊只有一個輸出值,就使用export default,如果模塊有多個輸出值,就不使用export default,export default與普通的export不要同時使用。
  • 不要在模塊輸入中使用通配符。因為這樣可以確保你的模塊之中,有一個默認輸出(export default)。
// bad
import * as myObject from './importModule';

// good
import myObject from './importModule';
  • 如果模塊默認輸出一個函數,函數名的首字母應該小寫。
function makeStyleGuide() {
}

export default makeStyleGuide;- ESLint 是一個語法規則和代碼風格的檢查工具,可以用來保證寫出語法正確、風格統一的代碼。
  • 如果模塊默認輸出一個對象,對象名的首字母應該大寫。
const StyleGuide = {
  es6: {
  }
};

export default StyleGuide;
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容