💩 以一種代碼已經被混淆的方式命名變量
如果我們鍵入的東西越少，那麼就有越多的時間去思考代碼邏輯等問題。
Good 👍🏻
let a = 42;
複製代碼Bad 👎🏻
let age = 42;
複製代碼💩 變量/函數混合命名風格
爲不同慶祝一下。
Good 👍🏻
let wWidth = 640;
let w_height = 480;
複製代碼Bad 👎🏻
let windowWidth = 640;
let windowHeight = 480;
複製代碼💩 不要寫註釋
反正沒人會讀你的代碼。
Good 👍🏻
const cdr = 700;
複製代碼Bad 👎🏻
更多時候，評論應該包含一些“爲什麼”，而不是一些“是什麼”。如果“什麼”在代碼中不清楚，那麼代碼可能太混亂了。
// 700ms的數量是根據UX A/B測試結果進行經驗計算的。
// @查看: <詳細解釋700的一個鏈接>
const callbackDebounceRate = 700;
複製代碼💩 使用母語寫註釋
如果您違反了“無註釋”原則，那麼至少嘗試用一種不同於您用來編寫代碼的語言來編寫註釋。如果你的母語是英語，你可能會違反這個原則。
Good 👍🏻
// Закриваємо модальне віконечко при виникненні помилки.
toggleModal(false);
複製代碼Bad 👎🏻
// 隱藏錯誤彈窗
toggleModal(false);
複製代碼💩 儘可能混合不同的格式
爲不同慶祝一下。
Good 👍🏻
let i = [‘tomato’, ‘onion’, ‘mushrooms’];
let d = [ “ketchup”, “mayonnaise” ];
複製代碼Bad 👎🏻
let ingredients = [‘tomato’, ‘onion’, ‘mushrooms’];
let dressings = [‘ketchup’, ‘mayonnaise’];
複製代碼💩 儘可能把代碼寫成一行
Good 👍🏻
document.location.search.replace(/(^?)/,’’).split(’&’).reduce(function(o,n){n=n.split(’=’);o[n[0]]=n[1];return o},{})
複製代碼Bad 👎🏻
document.location.search
.replace(/(^?)/, ‘’)
.split(’&’)
.reduce((searchParams, keyValuePair) => {
keyValuePair = keyValuePair.split(’=’);
searchParams[keyValuePair[0]] = keyValuePair[1];
return searchParams;
},
{}
)
複製代碼💩 不要處理錯誤
無論何時發現錯誤，都沒有必要讓任何人知道它。沒有日誌，沒有錯誤彈框。
Good 👍🏻
try {
// 意料之外的情況。
} catch (error) {
// tss… 🤫
}
複製代碼Bad 👎🏻
try {
// 意料之外的情況。
} catch (error) {
setErrorMessage(error.message);
// and/or
logError(error);
}
複製代碼💩 廣泛使用全局變量
全球化的原則。
Good 👍🏻
let x = 5;
function square() {
x = x ** 2;
}
square(); // 現在x是25
複製代碼Bad 👎🏻
let x = 5;
function square(num) {
return num ** 2;
}
x = square(x); // 現在x是25
複製代碼💩 創建你不會使用的變量
以防萬一。
Good 👍🏻
function sum(a, b, c) {
const timeout = 1300;
const result = a + b;
return a + b;
}
複製代碼Bad 👎🏻
function sum(a, b) {
return a + b;
}
複製代碼💩 如果語言允許，不要指定類型和/或不執行類型檢查。
Good 👍🏻
function sum(a, b) {
return a + b;
}
// 在這裏享受沒有註釋的快樂
const guessWhat = sum([], {}); // -> “[object Object]”
const guessWhatAgain = sum({}, []); // -> 0
複製代碼Bad 👎🏻
function sum(a: number, b: number): ?number {
// 當我們在JS中不做置換和/或流類型檢查時，覆蓋這種情況。
if (typeof a !== ‘number’ && typeof b !== ‘number’) {
return undefined;
}
return a + b;
}
// 這個應該在轉換/編譯期間失敗。
const guessWhat = sum([], {}); // -> undefined
複製代碼💩 你應該有不能到達的代碼
這是你的 “Plan B”.
Good 👍🏻
function square(num) {
if (typeof num === ‘undefined’) {
return undefined;
}
else {
return num ** 2;
}
return null; // 這就是我的"Plan B".
}
複製代碼Bad 👎🏻
function square(num) {
if (typeof num === ‘undefined’) {
return undefined;
}
return num ** 2;
}
複製代碼💩 三角法則
就像鳥巢，鳥巢，鳥巢。
Good 👍🏻
function someFunction() {
if (condition1) {
if (condition2) {
asyncFunction(params, (result) => {
if (result) {
for (;😉 {
if (condition3) {
}
}
}
})
}
}
}
複製代碼Bad 👎🏻
async function someFunction() {
if (!condition1 || !condition2) {
return;
}
const result = await asyncFunction(params);
if (!result) {
return;
}
for (;😉 {
if (condition3) {
}
}
}
複製代碼💩 混合縮進
避免縮進，因爲它們會使複雜的代碼在編輯器中佔用更多的空間。如果你不喜歡迴避他們，那就和他們搗亂。
Good 👍🏻
const fruits = [‘apple’,
‘orange’, ‘grape’, ‘pineapple’];
const toppings = [‘syrup’, ‘cream’,
‘jam’,
‘chocolate’];
const desserts = [];
fruits.forEach(fruit => {
toppings.forEach(topping => {
desserts.push([
fruit,topping]);
});})
複製代碼Bad 👎🏻
const fruits = [‘apple’, ‘orange’, ‘grape’, ‘pineapple’];
const toppings = [‘syrup’, ‘cream’, ‘jam’, ‘chocolate’];
const desserts = [];
fruits.forEach(fruit => {
toppings.forEach(topping => {
desserts.push([fruit, topping]);
});
})
複製代碼💩 不要鎖住你的依賴項
以非受控方式更新每個新安裝的依賴項。爲什麼堅持使用過去的版本，讓我們使用最先進的庫版本。
Good 👍🏻
$ ls -la
package.json
複製代碼Bad 👎🏻
$ ls -la
package.json
package-lock.json
複製代碼💩 函數長的比短的好
不要把程序邏輯分成可讀的部分。如果IDE的搜索停止，而您無法找到所需的文件或函數，該怎麼辦?
一個文件中10000行代碼是OK的。
一個函數體1000行代碼是OK的。
處理許多服務(第三方和內部，也有一些工具、數據庫手寫ORM和jQuery滑塊)在一個’ service.js ’ ?這是OK的。