淘寶JavaScript 編碼風(fēng)格規(guī)范
當(dāng)前位置:點(diǎn)晴教程→知識(shí)管理交流
→『 技術(shù)文檔交流 』
行與縮進(jìn) 語(yǔ)句行 盡可能不要讓每行超過(guò) 120 個(gè)字符; 語(yǔ)句必須以分號(hào)作為結(jié)束符, 不要忽略分號(hào); 空格 數(shù)值操作符(如, +/-/*/% 等)兩邊留空; 賦值操作符/等價(jià)判斷符兩邊留一空格; for 循環(huán)條件中, 分號(hào)后留一空格; 變量聲明語(yǔ)句, 數(shù)組值, 對(duì)象值及函數(shù)參數(shù)值中的逗號(hào)后留一空格; 空行不要有空格; 行尾不要有空格; 逗號(hào)和冒號(hào)后一定要跟空格; 點(diǎn)號(hào)前后不要出現(xiàn)空格; 空對(duì)象和數(shù)組不需要填入空格; 函數(shù)名末尾和左括號(hào)之間不要出現(xiàn)空格; 空行 邏輯上獨(dú)立的代碼塊使用空行分隔; 文件末尾留 1~2 個(gè)空行; 不要吝嗇空行. 盡量使用空行將邏輯相關(guān)的代碼塊分割開(kāi), 以提高程序的可讀性. 縮進(jìn) 以 4 個(gè)空格為一縮進(jìn)層次; 變量聲明: 多個(gè)變量聲明時(shí), 適當(dāng)換行表示; 參照 var 關(guān)鍵字, 縮進(jìn)一層次; 函數(shù)參數(shù): 函數(shù)參數(shù)寫(xiě)在同一行上; 傳遞匿名函數(shù)時(shí), 函數(shù)體應(yīng)從調(diào)用該函數(shù)的左邊開(kāi)始縮進(jìn); 數(shù)組和對(duì)象初始化時(shí): 如果初始值不是很長(zhǎng), 盡量保持寫(xiě)在單行上; 初始值占用多行時(shí), 縮進(jìn)一層次; 對(duì)象中, 比較長(zhǎng)的變量/數(shù)值, 不要以冒號(hào)對(duì)齊; 二元/三元操作符: 操作符始終跟隨前行; 實(shí)在需要縮進(jìn)時(shí), 按照上述縮進(jìn)風(fēng)格; 表達(dá)式中的縮進(jìn)同變量聲明時(shí); 括號(hào) 原則: 不要濫用括號(hào), 必要時(shí)一定要使用. if/else/while/for 條件表達(dá)式必須有小括號(hào); 語(yǔ)句塊必須有大括號(hào); 一元操作符(如 delete, typeof, void)或在某些關(guān)鍵詞(如 return, throw, case, new) 之后, 不要使用括號(hào); 變量 變量如有較廣的作用域, 使用全局變量; 如果是在類(lèi)中, 可以設(shè)計(jì)成為一個(gè)類(lèi)的成員; 函數(shù)體中, 多個(gè)局部變量集中在一起聲明, 避免分散; 適當(dāng)延遲變量的初始化; 字符串 JS 代碼中, 單行字符串使用單引號(hào); JS 代碼中, 多行字符串使用 + 拼接形式, 不要使用 \ 拼接; HTML 中 Element 屬性, 使用雙引號(hào); 命名規(guī)范 原則: * 盡量避免潛在沖突; * 精簡(jiǎn)短小, 見(jiàn)名知意; 普通變量統(tǒng)一使用駝峰形式; 常量使用全部大寫(xiě), 多個(gè)單詞以下劃線分隔; 枚舉量, 同常量; 私有變量, 屬性和方法, 名字以下劃線開(kāi)頭; 保護(hù)變量, 屬性和方法, 名字同普通變量名; 方法和函數(shù)的可選參數(shù), 名字以 opt_ 開(kāi)頭, 使用 @param 標(biāo)記說(shuō)明; 方法和函數(shù)的參數(shù)個(gè)數(shù)不固定時(shí): 可添加參數(shù) var_args 為參數(shù)個(gè)數(shù); 取代使用 arguments; 使用 @param 標(biāo)記說(shuō)明; Getter/Setter 命名: 以 getFoo/setFoo(value) 形式; 布爾類(lèi)型使用 isFoo()/hasFoo()/canDo()/shouldDO() 也可; 命名空間: 為全局代碼使用命名空間, 如 sloth.*; 外部代碼和內(nèi)部代碼使用不同的命名空間; 重命名那些名字很長(zhǎng)的變量, 不要在全局范圍內(nèi)創(chuàng)建別名, 而僅在函數(shù)塊作用域中使用; 文件名應(yīng)全部使用小寫(xiě)字符, 且不包含除 - 和 _ 外的標(biāo)點(diǎn)符號(hào); 臨時(shí)的重復(fù)變量建議以 i, j, k, ..., 命名;
聲明變量時(shí), 必須加上 var 關(guān)鍵字. 盡量減少全局變量的使用. 語(yǔ)句總是以分號(hào)結(jié)尾. 不要在塊內(nèi)聲明函數(shù). 標(biāo)準(zhǔn)特性?xún)?yōu)于非標(biāo)準(zhǔn)特性(如果類(lèi)庫(kù)有提供, 優(yōu)先使用類(lèi)庫(kù)中的函數(shù)). 不要封裝基本類(lèi)型. 只在解析序列化串時(shí)使用 eval() . 禁止使用 with . 減少使用 continue 和 break . 僅在函數(shù)內(nèi)使用 this . 使用 Array/Object 直接量, 避免使用 Array/Object 構(gòu)造器. 禁止修改內(nèi)置對(duì)象的原型. 該文章在 2012/5/2 12:23:46 編輯過(guò) |
關(guān)鍵字查詢(xún)
相關(guān)文章
正在查詢(xún)... |