前言

這是一份旨在增強團隊的開發(fā)協(xié)作，提高代碼質量和打造開發(fā)基石的編碼風格規(guī)范，其中包含了 html，css，javascript 和 jquery 這幾個部分。我們知道，當一個團隊開始指定并實行編碼規(guī)范的話，錯誤就會變得更加顯而易見。如果一段特定的代碼不符合規(guī)范的話，它有可能只是代碼風格錯誤，而也有可能會是 bug。早期指定規(guī)范就使得代碼審核得以更好的開展，并且可以更精確的地定位到錯誤。只要開發(fā)者們能夠保證源代碼源文件都嚴格遵循規(guī)范，那接下去所使用的混淆、壓縮和編譯工具則可投其所好不盡相同。

注釋規(guī)范

頂部注釋

文件頂部必須加上文件申明信息，包括文件描述、作者、最后更新(更新人和時間)

/*
* @description: 中文說明
* @author: name
* @update: name (2013-04-13 18:32)
*/

模塊注釋

模塊注釋必須單獨寫在一行

/* module: module1 by 張三 */
…
/* module: module2 by 張三 */

單行注釋與多行注釋

單行注釋

單行注釋可以寫在單獨一行，注釋中的每一行長度不超過40個漢字，或者80個英文字符。

/* this is a short comment */

多行注釋

/*
* this is comment line 1.
* this is comment line 2.
*/

特殊注釋

用于標注修改、待辦等信息

/* TODO: xxxx by name 2013-04-13 18:32 */

/* BUGFIX: xxxx by name 2012-04-13 18:32 */

區(qū)塊注釋

對一個代碼區(qū)塊注釋（可選），將樣式語句分區(qū)塊并在新行中對其注釋。

/* Header */
/* Footer */
/* Gallery */