HTML
語義
HTML5為我們提供了大量的語義元素，旨在精準地描述內容。確保你受益於其豐富的詞彙。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
<!-- bad --> <div id="main"> <div class="article"> <div class="header"> <h1>Blog post</h1> <p>Published: <span>21st Feb, 2015</span></p> </div> <p>…</p> </div> </div> <!-- good --> <main> <article> <header> <h1>Blog post</h1> <p>Published: <time datetime="2015-02-21">21st Feb, 2015</time></p> </header> <p>…</p> </article> </main> |
確保您理解您正在使用的語義元素。以錯誤的方式使用語義元素比不使用更糟糕。
|
1 2 3 4 5 6 7 8 9 10 11 |
<!-- bad --> <h1> <figure> <img alt=Company src=logo.png> </figure> </h1> <!-- good --> <h1> <img alt=Company src=logo.png> </h1> |
簡潔
保持程式碼簡潔。忘記舊的XHTML習慣。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
<!-- bad --> <!doctype html> <html lang=en> <head> <meta http-equiv=Content-Type content="text/html; charset=utf-8" /> <title>Contact</title> <link rel=stylesheet href=style.css type=text/css /> </head> <body> <h1>Contact me</h1> <label> Email address: <input type=email placeholder=you@email.com required=required /> </label> <script src=main.js type=text/javascript></script> </body> </html> <!-- good --> <!doctype html> <html lang=en> <meta charset=utf-8> <title>Contact</title> <link rel=stylesheet href=style.css> <h1>Contact me</h1> <label> Email address: <input type=email placeholder=you@email.com required> </label> <script src=main.js></script> </html> |
可訪問性
可訪問性不應該是一個事後的想法。你不必成為一位WCAG專家來提升你的網站，你可以立即開始修復這些小問題，它將產生巨大的改善，如:
- 學會正確使用alt屬性
- 確保你的連結和按鈕等都很好地標記(沒有<div class =button>這種暴行)
- 不要完全依賴顏色來傳達資訊
- 顯式地給表單控制元件加標籤
|
1 2 3 4 5 |
<!-- bad --> <h1><img alt="Logo" src="logo.png"></h1> <!-- good --> <h1><img alt="My Company, Inc." src="logo.png"></h1> |
語言
雖然定義語言和字元編碼是可選的，但推薦在文件級別宣告它們，即使它們已經在HTTP請求頭部已經指定。字元編碼優先使用utf – 8。
|
1 2 3 4 5 6 7 8 9 10 |
<!-- bad --> <!doctype html> <title>Hello, world.</title> <!-- good --> <!doctype html> <html lang=en> <meta charset=utf-8> <title>Hello, world.</title> </html> |
效能
除非有一個合理的理由在內容之前載入指令碼，否則請不要把它放在前面阻止頁面的渲染。如果您的樣式表很大，分離出初始化時必須的樣式，並在一個獨立樣式表中延遲載入其它部分。兩次HTTP請求顯著低於一次，但感知速度是最重要的因素。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<!-- bad --> <!doctype html> <meta charset=utf-8> <script src=analytics.js></script> <title>Hello, world.</title> <p>...</p> <!-- good --> <!doctype html> <meta charset=utf-8> <title>Hello, world.</title> <p>...</p> <script src=analytics.js></script> |
CSS
分號
技術上來講，分號在CSS裡充當一個分隔符，但請把它當作一個終結符。
|
1 2 3 4 5 6 7 8 9 |
/* bad */ div { color: red } /* good */ div { color: red; } |
盒模型
盒模型對整個文件應該是相同的。雖然全域性樣式 * { box-sizing:border-box;} 很好，但不要在特定元素改變預設的盒模型（如果你可以避免這麼做）。
|
1 2 3 4 5 6 7 8 9 10 11 |
/* bad */ div { width: 100%; padding: 10px; box-sizing: border-box; } /* good */ div { padding: 10px; } |
流
不要改變元素的預設行為（如果你可以避免這麼做）。儘量保持元素在普通的文件流中。例如，刪除影像下面的空白，不應該改變其預設顯示:
|
1 2 3 4 5 6 7 8 9 |
/* bad */ img { display: block; } /* good */ img { vertical-align: middle; } |
同樣的，不要讓一個元素脫離文件流（如果你可以避免這麼做）。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
/* bad */ div { width: 100px; position: absolute; right: 0; } /* good */ div { width: 100px; margin-left: auto; } |
位置
有很多方法可以在CSS中定位元素，但嘗試限制自己使用下面的屬性/值。優先順序如下:
|
1 2 3 4 5 6 |
display: block; display: flex; position: relative; position: sticky; position: absolute; position: fixed; |
選擇器
減少緊耦合的DOM選擇器。當你的選擇器超過3個結構偽類、後代或兄弟的組合，考慮新增一個class到你需要匹配的元素上。
|
1 2 3 4 5 |
/* bad */ div:first-of-type :last-child > p ~ * /* good */ div:first-of-type .info |
避免在不必要的時候過載你的選擇器。
|
1 2 3 4 5 6 7 8 9 |
/* bad */ img[src$=svg], ul > li:first-child { opacity: 0; } /* good */ [src$=svg], ul > :first-child { opacity: 0; } |
特性
不要讓選擇器難以覆蓋。減少使用 id 和避免 !important。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
/* bad */ .bar { color: green !important; } .foo { color: red; } /* good */ .foo.bar { color: green; } .foo { color: red; } |
覆蓋
覆蓋樣式讓選擇器和除錯變得不易使用。儘可能避免它。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
/* bad */ li { visibility: hidden; } li:first-child { visibility: visible; } /* good */ li + li { visibility: hidden; } |
繼承
在可以繼承的情況下，不要重複樣式宣告,。
|
1 2 3 4 5 6 7 8 9 |
/* bad */ div h1, div p { text-shadow: 0 1px 0 #fff; } /* good */ div { text-shadow: 0 1px 0 #fff; } |
簡潔
保持程式碼簡潔。使用簡寫屬性，避免在不需要時使用多個屬性。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/* bad */ div { transition: all 1s; top: 50%; margin-top: -10px; padding-top: 5px; padding-right: 10px; padding-bottom: 20px; padding-left: 10px; } /* good */ div { transition: 1s; top: calc(50% - 10px); padding: 5px 10px 20px; } |
語言
優先使用英文而不是數學公式
|
1 2 3 4 5 6 7 8 9 |
/* bad */ :nth-child(2n + 1) { transform: rotate(360deg); } /* good */ :nth-child(odd) { transform: rotate(1turn); } |
瀏覽器引擎字首
積極刪除過時的瀏覽器引擎字首。如果你需要使用它們，請在標準屬性前插入。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
/* bad */ div { transform: scale(2); -webkit-transform: scale(2); -moz-transform: scale(2); -ms-transform: scale(2); transition: 1s; -webkit-transition: 1s; -moz-transition: 1s; -ms-transition: 1s; } /* good */ div { -webkit-transform: scale(2); transform: scale(2); transition: 1s; } |
動畫
優先使用過渡，而不是動畫。避免對 opacity 和 transform 以外的屬性使用動畫。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
/* bad */ div:hover { animation: move 1s forwards; } @keyframes move { 100% { margin-left: 100px; } } /* good */ div:hover { transition: 1s; transform: translateX(100px); } |
單位
在可以的情況下，使用沒有單位的值。在你使用相對單位時優先 rem 。優先使用秒而不是毫秒。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
/* bad */ div { margin: 0px; font-size: .9em; line-height: 22px; transition: 500ms; } /* good */ div { margin: 0; font-size: .9rem; line-height: 1.5; transition: .5s; } |
顏色
如果你需要透明效果，請使用rgba。否則，總是使用十六進位制格式。
|
1 2 3 4 5 6 7 8 9 |
/* bad */ div { color: hsl(103, 54%, 43%); } /* good */ div { color: #5a3; } |
繪圖
當資源可以輕易地通過CSS實現時，避免HTTP請求。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
/* bad */ div::before { content: url(white-circle.svg); } /* good */ div::before { content: ""; display: block; width: 20px; height: 20px; border-radius: 50%; background: #fff; } |
Hacks
不要使用它們。
|
1 2 3 4 5 6 7 8 9 10 11 |
/* bad */ div { // position: relative; transform: translateZ(0); } /* good */ div { /* position: relative; */ will-change: transform; } |
JavaScript
效能
可讀性，正確性和可表達性優先於效能。JavaScript基本上永遠不會成為你的效能瓶頸。優化影像壓縮、網路訪問和DOM渲染。如果你僅記得本文的一條原則，記住這條。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// bad (albeit way faster) const arr = [1, 2, 3, 4]; const len = arr.length; var i = -1; var result = []; while (++i < len) { var n = arr[i]; if (n % 2 > 0) continue; result.push(n * n); } // good const arr = [1, 2, 3, 4]; const isEven = n => n % 2 == 0; const square = n => n * n; const result = arr.filter(isEven).map(square); |
無汙染
儘量保持你的函式乾淨。所有函式最好無副作用，不使用外部資料，返回新物件而不是改變現有的物件。
|
1 2 3 4 5 6 7 |
// bad const merge = (target, ...sources) => Object.assign(target, ...sources); merge({ foo: "foo" }, { bar: "bar" }); // => { foo: "foo", bar: "bar" } // good const merge = (...sources) => Object.assign({}, ...sources); merge({ foo: "foo" }, { bar: "bar" }); // => { foo: "foo", bar: "bar" } |
原生
儘可能地依靠原生方法。
|
1 2 3 4 5 6 7 |
// bad const toArray = obj => [].slice.call(obj); // good const toArray = (() => Array.from ? Array.from : obj => [].slice.call(obj) )(); |
強制轉換
當有必要時，擁抱隱式強制轉換。否則避免它。不要盲目使用。
|
1 2 3 4 5 |
// bad if (x === undefined || x === null) { ... } // good if (x == undefined) { ... } |
迴圈
當強迫使用可變的物件時，不要使用迴圈。依靠 array.prototype 中的方法。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// bad const sum = arr => { var sum = 0; var i = -1; for (;arr[++i];) { sum += arr[i]; } return sum; }; sum([1, 2, 3]); // => 6 // good const sum = arr => arr.reduce((x, y) => x + y); sum([1, 2, 3]); // => 6 |
如果你不能，或者使用 array.prototype 方法很虐心。使用遞迴。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
// bad const createDivs = howMany => { while (howMany--) { document.body.insertAdjacentHTML("beforeend", "<div></div>"); } }; createDivs(5); // bad const createDivs = howMany => [...Array(howMany)].forEach(() => document.body.insertAdjacentHTML("beforeend", "<div></div>") ); createDivs(5); // good const createDivs = howMany => { if (!howMany) return; document.body.insertAdjacentHTML("beforeend", "<div></div>"); return createDivs(howMany - 1); }; createDivs(5); |
Arguments
忘記 arguments 物件。rest 引數一直是一個更好的選擇，因為:
- 它是命名的，所以它給你一個函式期望arguments的更好的做法
- 它是一個真正的陣列，這使得它更容易使用。
|
1 2 3 4 5 6 |
// bad const sortNumbers = () => Array.prototype.slice.call(arguments).sort(); // good const sortNumbers = (...numbers) => numbers.sort(); |
Apply
忘記 apply() 。使用 spread 操作符代替。
|
1 2 3 4 5 6 7 8 |
const greet = (first, last) => `Hi ${first} ${last}`; const person = ["John", "Doe"]; // bad greet.apply(null, person); // good greet(...person); |
Bind
當有慣用方法時，不要使用 bind() 。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
// bad ["foo", "bar"].forEach(func.bind(this)); // good ["foo", "bar"].forEach(func, this); // bad const person = { first: "John", last: "Doe", greet() { const full = function() { return `${this.first} ${this.last}`; }.bind(this); return `Hello ${full()}`; } } // good const person = { first: "John", last: "Doe", greet() { const full = () => `${this.first} ${this.last}`; return `Hello ${full()}`; } } |
高階函式
在不必要時，避免巢狀函式。
|
1 2 3 4 5 |
// bad [1, 2, 3].map(num => String(num)); // good [1, 2, 3].map(String); |
組合
避免多巢狀函式的呼叫。使用組合。
|
1 2 3 4 5 6 7 8 9 10 |
const plus1 = a => a + 1; const mult2 = a => a * 2; // bad mult2(plus1(5)); // => 12 // good const pipeline = (...funcs) => val => funcs.reduce((a, b) => b(a), val); const addThenMult = pipeline(plus1, mult2); addThenMult(5); // => 12 |
快取
快取功能測試、大資料結構和任何昂貴的操作。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// bad const contains = (arr, value) => Array.prototype.includes ? arr.includes(value) : arr.some(el => el === value); contains(["foo", "bar"], "baz"); // => true // good const contains = (() => Array.prototype.includes ? (arr, value) => arr.includes(value) : (arr, value) => arr.some(el => el === value) )(); contains(["foo", "bar"], "baz"); // => true |
變數定義
優先const，再是let，然後是var。
|
1 2 3 4 5 6 7 8 |
// bad var obj = {}; obj["foo" + "bar"] = "baz"; // good const obj = { ["foo" + "bar"]: "baz" }; |
條件
優先使用立即執行函式表示式（IIFE和返回語句，而不是 if，else if 和 switch 語句
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// bad var grade; if (result < 50) grade = "bad"; else if (result < 90) grade = "good"; else grade = "excellent"; // good const grade = (() => { if (result < 50) return "bad"; if (result < 90) return "good"; return "excellent"; })(); |
物件迭代
在允許的情況下避免使用 for…in
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
const shared = { foo: "foo" }; const obj = Object.create(shared, { bar: { value: "bar", enumerable: true } }); // bad for (var prop in obj) { if (obj.hasOwnProperty(prop)) console.log(prop); } // good Object.keys(obj).forEach(prop => console.log(prop)); |
物件對映
當物件合法使用情況下，map 通常是一個更好的，更強大的選擇。如果有疑問,請使用 map 。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
// bad const me = { name: "Ben", age: 30 }; var meSize = Object.keys(me).length; meSize; // => 2 me.country = "Belgium"; meSize++; meSize; // => 3 // good const me = new Map(); me.set("name", "Ben"); me.set("age", 30); me.size; // => 2 me.set("country", "Belgium"); me.size; // => 3 |
Curry（柯里化）
柯里局可能在其他語言有它的地位，但避免在 JavaScript 使用。它通過引入外來正規化，且相關的用例極不尋常，使得您的程式碼更難閱讀。
|
1 2 3 4 5 6 7 |
// bad const sum = a => b => a + b; sum(5)(3); // => 8 // good const sum = (a, b) => a + b; sum(5, 3); // => 8 |
可讀性
不要通過看似聰明的技巧來混淆程式碼的意圖。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
// bad foo || doSomething(); // good if (!foo) doSomething(); // bad void function() { /* IIFE */ }(); // good (function() { /* IIFE */ }()); // bad const n = ~~3.14; // good const n = Math.floor(3.14); |
程式碼重用
不要害怕創造大量小，高度可組合、可重用的函式。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// bad arr[arr.length - 1]; // good const first = arr => arr[0]; const last = arr => first(arr.slice(-1)); last(arr); // bad const product = (a, b) => a * b; const triple = n => n * 3; // good const product = (a, b) => a * b; const triple = product.bind(null, 3); |
依賴
減少依賴。第三方程式碼你不熟悉。不要僅僅為了使用一些很容易複製的方法而載入整個庫：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// bad var _ = require("underscore"); _.compact(["foo", 0])); _.unique(["foo", "foo"]); _.union(["foo"], ["bar"], ["foo"]); // good const compact = arr => arr.filter(el => el); const unique = arr => [...Set(arr)]; const union = (...arr) => unique([].concat(...arr)); compact(["foo", 0]); unique(["foo", "foo"]); union(["foo"], ["bar"], ["foo"]); |