原文:垃圾程式碼書寫準則
單詞命名的變數寫完整。
多詞命名的變數使用 camelCase
let windowWidth = 640;
let windowHeight = 480;
Boolean 值的變數不要只會命名 flag,要用 is 開頭
let isDone = false;
let isEmpty = false;
應該包含「為什麼(why)」,而不是「是什麼(what)」。
「是什麼(what)」應該在程式碼就表達清楚。
使用英文寫註釋。
單雙引號統一、程式碼風格統一
不要把程式碼全都寫成一行
不要將程式碼寫成巢狀
不要建立不會使用的變數
不要胡亂縮排
刪除用不到的程式碼
注意語法邏輯,不要寫出永遠不會跑到的程式碼
如以下 plan B
function square(num) {
if (typeof num === 'undefined') {
return undefined;
}
else {
return num ** 2;
}
return null; // This is my "Plan B"
}
要有 README