首頁 > web前端 > js教程 > 詳細介紹JavaScript 程式碼風格指南

詳細介紹JavaScript 程式碼風格指南

黄舟
發布: 2017-03-13 16:52:12
原創
1529 人瀏覽過

一.基本格式

縮排

建議每級4個空格,可以給編輯器設定tab = 4個空格,自動轉換

分號

不要省略分號,防止ASI(自動插入分號)錯誤

行寬

每行代碼不超過80個字符,過長應該用操作符手動斷行

#斷行

操作符在上一行末尾,且下一行縮排2級,如果是賦值語句,也應該和等號後面部分對齊

#空行

函數聲明與函數宣告、變數宣告與函數宣告、函數內部的邏輯區塊之間都應該有空行隔開

作者尼古拉斯也建議在流程控制區塊頂部留一個空行,但給的例子不是很明確

命名

  • #變數名/函數名稱:Camel(駝峰)規則,首詞首字母小寫,後續詞首字母大寫,其餘部分小寫

  • #常數名:C語言式,全大寫,底線分詞

  • 建構子:Pascal規則,所有詞首字母大寫,其餘部分小寫

字面量

  • 字串:雙引號包裹,斷行用[+]運算符,不要用\轉義字元

  • 數值:不要省略小數點前後的部分,不要用八進位形式

  • #Null:只把null當作Object的佔位符,不要用來偵測形參,也不要用來偵測未初始化的變數

  • #Undefined:應該把所有物件都初始化為null,以區分未定義和未初始化

  • 物件字面量/陣列字面量:不要用建構函式方式宣告物件和陣列

二.註解

P.S.書中有一句很經典的解釋:

Appropriately written comments help tell the story of code, allowing other developers to drop into a part of the story without needing to hear the beginning.

單行註解

  • 行尾:用1級縮排隔開程式碼,而且//後面要有一個空格

  • 獨佔一行:用來註解下面,要與被註解的程式碼保持相同的縮排

  • 行首:用來註解多行程式碼

#多行註解

用來包覆大段註釋,推薦Eclipse風格,例如

/*
 * comment line1
 * comment line2
 */
登入後複製

注意:

  • 多行註解上方留一個空白行

  • *星號後面留一個空格

  • 多行註解至少三行(因為第一行和最後一行後面不加註解)

在哪裡添註解

  • 不能自解釋的程式碼

  • 故意的,但看起來像是有錯的地方

  • 針對瀏覽器的hack

#文件註解

#應該要為各個函數添註釋,包括功能描述、參數、傳回值、拋出的錯誤等等,例如推薦的Eclipse風格:

/**
 * 添加指定元素到默认数组
 *
 * @method add
 * @param {Number} 将要添加的元素
 * @return {Boolean} 添加成功/失败
 * @throw {TypeError} 参数类型不匹配
 */
function add(item){
    if(typeof item === "number"){
        arr.push(item)
    }
    else{
        throw new TypeError();
    }
}
登入後複製

三.語句和表達式

花括號對齊方式

建議行尾風格,不推薦次行風格

區塊語句空格

if後的圓括號部分前後各有一個空格,例如:

if (expr) {
    code
}
登入後複製

switch語句

  • 縮排:case與switch對齊,break縮排1級

  • case貫穿:用空白行或註解//falls through表明case貫穿是故意的

  • #default:保留default或用註解//no default表明沒有default

P.S.《JavaScript語言精粹》的作者道格拉斯認為不應該用case貫穿(稱為雞肋),因為極易引發bug,而尼古拉斯認為用空行或註解說明就好了

with語句

#不用

for迴圈

所有變數都應該在函數體頂部聲明,包括for循環初始化部分用到的變量,避免hosting(提升)引發bug(可能會屏蔽全域變數)

for-in循環

不要用來遍歷數組,用的時候記得加上hasOwnProperty過濾,如果故意遍歷原型屬性,應該用註解說明

四.變數、函數、運算子

變數宣告

函數體= 變數宣告+ 函數宣告+ 邏輯語句。用空白行隔開各個部分

函數宣告

先宣告再使用,千萬不要把函數宣告放在if分支裡,因為瀏覽器理解不同,而且ES沒給標準

函數呼叫

圓括號前後都不加空格,避免和區塊語句混淆

匿名函數立即執行

把立即執行的匿名函數用圓括號包裹,避免與匿名函數宣告混淆

嚴格模式

不要在全域作用域開嚴格模式,只在函數內部開,給多個函數開可以用匿名函數立即執行限定嚴格模式的作用域

判斷等於

只用===和!==

eval

#不用eval()和new Function(),用匿名函式最佳化setTimeout()和setInterval()

基本包裝類型

不要用new Boolean(), new String(), new Number()


以上是詳細介紹JavaScript 程式碼風格指南的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
最新問題
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板