最近的程序員不談世界上最好的語言是不是 php,也不談人生苦短,用不用 python, 研發、測試、運維一片其樂融融,研究的是垃圾分類。
比如小龍蝦到底是什麼垃圾?
然而祥和的氛圍不過三秒,在又看到一行刺眼的“垃圾代碼”時,為了避免還要對“垃圾代碼”進行分類,我們嘗試拯救一下這行代碼。
此處小編想說的“垃圾代碼”並不是真正的垃圾,而是在質量上有待規範,可以變得質量更高的代碼。
JavaScript 風格指南從 10 分方面進行歸類,列舉通用準則,讓你的代碼更加規範:
- 介紹
- 變量
- 函數
- 對象和數據結構
- 類
- 測試
- 併發
- 錯誤處理
- 格式化
- 註釋
舉個例子:
- 使用有意義,可讀性好的變量名
反例:
var yyyymmdstr = moment().format('YYYY/MM/DD');
正例:
var yearMonthDay = moment().format('YYYY/MM/DD');
- 使用 ES6 的 const 定義常量
反例中使用"var"定義的"常量"是可變的。
在聲明一個常量時,該常量在整個程序中都應該是不可變的。
反例:
var FIRST_US_PRESIDENT = "George Washington";
正例:
const FIRST_US_PRESIDENT = "George Washington";
- 對功能類似的變量名採用統一的命名風格
反例:
getUserInfo(); getClientData(); getCustomerRecord();
正例:
getUser();
- 使用易於檢索名稱
我們需要閱讀的代碼遠比自己寫的要多,使代碼擁有良好的可讀性且易於檢索非常重要。閱讀變量名晦澀難懂的代碼對讀者來說是一種相當糟糕的體驗。 讓你的變量名易於檢索。
反例:
// 525600 是什麼? for (var i = 0; i < 525600; i++) { runCronJob(); }
正例:
// Declare them as capitalized `var` globals. var MINUTES_IN_A_YEAR = 525600; for (var i = 0; i < MINUTES_IN_A_YEAR; i++) { runCronJob(); }
GitHub 地址:
英文版:https://github.com/ryanmcdermott/clean-code-javascript
中文版:https://github.com/alivebao/clean-code-js
網站崩潰找不到原因?平臺搭建無從下手?熱門技術不想落伍?想要變強找不到資料?
[IT拯救聯盟],讓大牛和同伴拯救你,帶你裝x帶你飛。定期乾貨分享、大牛專業解答、實用IT工具優選.....
私信小編“聯盟”,即可加入我們~
關鍵字: 分類 程序員 JavaScript