寫好你的JavaScript

勞卜發表於2017-03-02
JavaScript

關於

前言

在實際工作中，我們應該經常會看到一些功能上沒有問題，但編碼風格和規範卻十分糟糕的程式碼，這往往會讓人不敢再往下閱讀，甚至會影響閱讀者一天的心情。這些程式碼不僅不易閱讀，而且難以維護，它們一般會出自剛入門的程式設計新手，也會出自工作了好幾年的老程式設計師手下。因此本文的目的在於幫助那些沒有養成良好的編碼風格，缺乏相應編碼規範意識的JavaScript學習者們改善他們的編碼形象。

編碼形象

以上我提出了編碼形象的概念，我個人認為：

編碼形象 = 編碼風格 +　編碼規範複製程式碼

一個良好的編碼形象就等於一個穿著得體的青年，對於程式設計師來說這是同行瞭解你優秀能力的最直接最簡單的方式。

我們來看一下一段糟糕的編碼形象：

//打個招呼
function func(){
    var age=18,sex='man';
    var greeting='hello';
    if(age<=18&&sex=='man'){
        console.log(greeting+'little boy')
    }

    ...
}
func()複製程式碼

上方程式碼整體縮在了一起，缺乏規範意識，閱讀體驗很差，不忍直視。

再來看一段良好的程式碼形象：

// 打個招呼
function greetFn() {
    var age = 18,
        sex = 'man',
        greeting = 'hello';

    if (age <= 18 && sex === 'man') {
        console.log(greeting + 'little boy');
    }

    ...
};

greetFn();複製程式碼

上方的程式碼是不是感覺舒服多了？

由此可見養成一個良好的編碼形象是至關重要的，而本文主要講解的是基於JavaScript的編碼形象，即基於JavaScript的編碼風格和編碼規範。

那麼什麼是編碼風格，什麼是編碼規範，兩者的區別又是什麼？

編碼風格

首先編碼風格既然是風格，就沒有對錯之分。就好比每個人的穿著打扮不同，有的人穿的比較得體，有的人穿的比較隨意而已。

而在JavaScript編碼風格中，也有一套比較得體的風格，尤其在團隊開發中，我們不能隨意的書寫屬於自己的風格。

下面就列舉幾種隨意的編碼風格，並將其與良好的編碼風格進行對比。

1.合理註釋

// 不推薦的寫法
var name = '勞卜';//程式碼和註釋之間沒有間隔

if (name) {
    /*
     *註釋之前無空行
     *星號後面無空格
     */
}複製程式碼
// 推薦的寫法
var name = '勞卜'; // 程式碼和註釋之間有間隔

if (name) {

    /*
     * 註釋之前有空行
     * 星號後面有空格
     */
}複製程式碼

2.合理間隔

// 不推薦的寫法
var name='勞卜'; // 等號和兩側之間沒有間隔

// if塊級語句間沒有間隔
if(name){
    console.log('hello');
}複製程式碼
// 推薦的寫法
var name = '勞卜'; // 等號和兩側之間有間隔

// if塊級語句間有間隔
if (name) {
    console.log('hello');
}複製程式碼

3.合理縮排

// 不推薦的寫法：沒有合理縮排
function getName() {
console.log('勞卜'); 
}複製程式碼
// 推薦的寫法：合理縮排
function getName() {
    console.log('勞卜');
}複製程式碼

4.合理空行

// 不推薦的寫法: 程式碼功能塊之間沒有空行
function getName() {
    var name = '勞卜';
    if (name) {
        console.log('hello');
    }
}複製程式碼
// 推薦的寫法：程式碼功能塊之間有空行
function getName() {
    var name = '勞卜';

    if (name) {
        console.log('hello');
    }
}複製程式碼

5.合理命名

// 不推薦的寫法
var getName = '勞卜'; // 變數命名字首為動詞

// 函式命名字首為名詞
function name() {
   console.log('hello');
}複製程式碼
// 推薦的寫法
var name = '勞卜'; // 變數命名字首為名詞

// 函式命名字首為動詞
function getName() {
   console.log('hello');
}複製程式碼

6.合理宣告

// 不推薦的寫法：函式在宣告之前使用
getName(); 

function getName() {
    console.log('hello');
}複製程式碼
// 推薦的寫法：函式在宣告之後使用
function getName() {
    console.log('hello');
}

getName();複製程式碼

7.合理結尾

// 不推薦的寫法：沒有使用分號結尾
var name = '勞卜' 

var getName = function() {
    console.log('hello')
}複製程式碼
// 推薦的寫法：使用分號結尾
var name = '勞卜'; 

var getName = function() {
    console.log('hello');
};複製程式碼

以上主要列舉了7個比較常見的編碼風格的例子進行了比較，在推薦的寫法和不推薦的寫法中兩者並沒有對錯之分，只是推薦的寫法相比較而言更容易閱讀和維護，更適用於團隊開發，也是良好編碼形象的體現。

編碼規範

對於編碼規範，既然是規範，那我們就應該按照一定的規則來編寫。隨意編寫違反編碼規範的程式碼，可能會導致程式的出錯和潛在的bug，因此其相對於編碼風格來說應該更加嚴謹，也有人會把編碼風格包含在編碼規範之中。

下面就列舉幾個常見的例項程式碼：

1.比較引數

// 不推薦的寫法：==和!=比較時會進行型別轉換，應儘量避免使用
var num = 123;

if (num == '123') {
    console.log(num);
} else if (num != '321') {
    console.log('321');
}複製程式碼
// 推薦的寫法：使用===和!==來進行比較
var num = 123;

if (num === '123') {
    console.log(num);
} else if (num !== '321') {
    console.log('321');
}複製程式碼

2.包裹if語句

// 不推薦的寫法：if語句不用大話號包裹會出現潛在bug
var num = 123;

if (num === '123')
    console.log(num);複製程式碼
// 推薦的寫法：if語句用大話號包裹
var num = 123;

if (num === '123') {
    console.log(num);
}複製程式碼

3.慎用eval

// 不推薦的寫法：應避免使用eval，不安全，非常耗效能（一次解析成js語句，一次執行）
var json = '{"name": "勞卜", "func": alert("hello")}';

eval('(' + json + ')'); // 彈出“hello”複製程式碼
// 推薦的寫法
var json = '{"name": "勞卜", "func": alert("hello")}';

JSON.parse(json); // 校驗報錯複製程式碼

4.判斷型別

// 不推薦的寫法：用typeof來判斷建構函式建立的物件
var str = new String('勞卜'); 

console.log(typeof str); // 'object'複製程式碼
// 推薦的寫法：用instanceof來判斷建構函式建立的物件
var str = new String('勞卜'); 

console.log(str instanceof String); // true複製程式碼

5.檢測屬性

// 不推薦的寫法：使用undefined和null來檢測一個屬性是否存在
if (obj['name'] !== undefined) {
    console.log('name屬性存在'); // 若obj.name為undefined時則會導致判斷出錯
}

if (obj['name'] !== null) {
    console.log('name屬性存在'); // 若obj.name為null時則會導致判斷出錯
}複製程式碼
// 推薦的寫法：使用in運算子來檢測物件屬性是否存在，使用hasOwnProperty方法來檢測不包含原型鏈上的物件屬性是否存在
if ('name' in obj) {
    console.log('name屬性存在');
}

if (obj.hasOwnProperty('name')) {
    console.log('name屬性存在');
}複製程式碼

以上主要列舉了5個常見的編碼規範的例子，合理地規範自己的程式碼能夠很大程度上減少不必要的維護成本和潛在的bug風險，對於JavaScript學習者來說應該銘記於心。

結語

“程式是寫給人讀的，只是偶爾讓計算機執行一下。”我們不能為了貪圖一時的方便而親手毀了自己的程式碼形象，這會給他人和整個專案帶來不必要的麻煩。

本文內容參考自《編寫可維護的JavaScript》一書。

如果覺得本文對你有幫助，可以關注我的微信公眾號，來這裡聊點關於前端的事情。

寫好你的JavaScript

本文對你有幫助？歡迎掃碼加入前端學習小組微信群：

寫好你的JavaScript

相關文章