DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> CSS入門知識 >> 關於CSS
Web 前端開發規範文件(2014 年版)
編輯:關於CSS     

這份文件是前端團隊共同約定並遵循的程式碼撰寫規範,目的很單純:讓程式碼更一致、更好維護。

基本準則

符合 Web 標準、HTML 語意化、結構/樣式/行為分離、具備良好相容性。在效能面向上,程式碼要簡潔有序,盡量降低伺服器負擔,並確保最快的解析速度。

總則

1. 省略協議:寫 background: url(//www.google.com/images/example); 而不是帶 https:// 的完整寫法,方便 http 與 https 之間切換,除非確實必須指定某個協議。

2. 用 IDE 做層次分明的縮排,並以四個空格取代 tab。不同系統的編輯器對 tab 的解讀不一致——Windows 下通常等於四格,Linux 下可能變成八格(除非自行設定)。像 Sublime Text 這類工具就可以自訂 tab 寬度。

3. 標籤屬性一律小寫。
4. 行尾不留空白,避免 diff 出現無意義的雜訊。
5. 使用 UTF-8(不含 BOM),並在文件中加上 <meta charset="utf-8">。
6. 檔名統一小寫並以 .js 結尾,分隔詞建議用 - 而非 _。
7. 註記待辦事項時使用 TODO(contact) 或 TODO: action item,不要用 @@。

HTML 細則

1. 採用 HTML5 的 <!DOCTYPE html>。
2. <img> 預設寫法為 <img src="xxx.png" alt="替代文字" />,避免出現 src=""。
3. <a> 預設寫法為 <a href="###" title="連結名稱">xxx</a>;target="_blank" 依需求決定。
4. 需要用到的連結先以 ### 佔位。
5. 撰寫連結位址時避免多一層重導向,例如 href="https://itaolun.com/" 結尾要帶斜線。
6. 所有標籤都必須符合 XHTML 的閉合規則。
7. 自閉合標籤統一寫成 <br />、<hr />,注意斜線前留空格。
8. 不要使用已退場的標籤,例如以 <strong>、<em> 取代 <b>、<u>、<i>。
9. 自訂資料用 data-* 承載,例如 <input data-xxx="yyy" />。
10. 避免 style="xxx:xxx;" 這種行內樣式;特殊符號請參考 HTML 實體。
11. 具描述性的表單元素(input、textarea)一定要配 label。像 <p>姓名: <input type="text" id="name" name="name" /></p> 應該改寫為 <p><label for="name">姓名: </label><input type="text" id="name" /></p>。

CSS 細則

1. 每條屬性宣告都加分號。方便壓縮工具斷句。

2. class 命名使用連字號分隔單詞。比起駝峰,- 更清晰易讀;描述層級時也可以用「產品線-產品-模組-子模組」的方式。id 則採小駝峰,例如 firstName、topBoxList、footerCopyright。

3. 空格規則:

.hotel-content { font-weight: bold; }

選擇器與 { 之間要空格;屬性名 : 之後要空格;: 之前禁止空格。除了美觀,這也和早期 IE6 的解析 bug 有關。

4.(建議)屬性撰寫順序:

.hotel-content { /* 定位 */ display: block; position: absolute; left: 0; top: 0; /* 盒模型 */ width: 50px; height: 50px; margin: 10px; border: 1px solid black; /* 其他 */ color: #efefef; }

定位相關常見的有 display、position、left、top、float;盒模型相關有 width、height、margin、padding、border;其餘歸為其他屬性。

照這個順序寫,能改善瀏覽器渲染 DOM 的表現。舉例來說,若圖片沒有先宣告寬高,載入前它佔的空間是 0,載入完成後突然被撐開,底下的元素就得重新排列與渲染,造成重繪(repaint)與回流(reflow)。把定位寫在前面,瀏覽器先知道元素是在文本流內或外、落在頁面哪個位置,接著再拿到寬高與 border 等佔空間的資訊,其他屬性就在這個已確定的區域裡渲染。

延伸閱讀:Poll Results: How do you order your CSS properties?、https://www.mozilla.org/css/base/content.css

5.(建議)針對特定 HTML 結構寫樣式時,用「元素名 + 類名」。

/* 這組樣式只作用於 ul 結構的導覽 */ ul.nav { ...... }

".a div" 與 ".a div.b" 為什麼後者比較好?因為需求變動時,若 .a 底下又多了一個 div,前者寫法會讓原本的樣式誤傷新元素。

6.(不建議)IE 的 filter;expression 則禁止使用。這主要是效能考量,應避免耗 CPU 的寫法。

7. CSS 註解以 /* */ 表示。單行註解時,註解內容與前後註解符各留一個空格並獨立成行;多行註解時,起訖符各自佔一行。例如:

/* 註解 CSS */

/* table { border-collapse: collapse; } */

JavaScript 細則

1. 換行:每行以 120 字元為上限,超過就該換行;.、+ 這類運算子放在行尾,換行後的內容要多一層縮排。函式或方法的參數過長時應適度切分。禁止在 return 與回傳運算式之間換行,否則實際回傳的會是 undefined:

// 實際上回傳的是 undefined,不是 1 function test() { return 1; }

2. 一行只寫一條語句。if、for、do、while、switch、case、default、break、continue 各自獨立一行;所有迴圈與條件式的執行區塊都必須用 {} 包住,不得省略:

// 錯誤寫法 if (i < 5) i += 1; // 正確寫法 if (i < 5) { i += 1 }

3. 對齊:{ 緊接在上一行尾端並以一個空格隔開,} 獨立一行、與對應語句左對齊。函式主體、類別定義以及 if、for、do、while、switch、case 的區塊都照此縮排。

4. 空格:關鍵字後要空格以突顯關鍵字;函式名、方法名與左括號之間不留空格。

// 錯誤 function getInfo () { } // 正確 function getInfo() { }
// 錯誤 var user = function () { } // 正確 var user = function() { }

逗號後加空格。賦值、比較、算術、邏輯、位元運算等二元運算子(=、+=、>=、<=、+、*、%、&&、||)前後都要空格;!、~、++、--、&(取位址)等單目運算子前後不加;. 與 [] 前後也不加。

5. 空行:每個類別宣告後、每個函式定義結束後都要空一行。函式體內部,邏輯上緊密相關的語句之間不空行,其餘以空行分隔。

6. 嚴格比較:用 === 取代 ==,用 !== 取代 !=。
7. 避免多餘逗號,例如 var arr = [1,2,3,]。
8. 語句一律以分號結尾,for、function、if、switch、try、while 除外。
9. 左花括號置於行末,右花括號獨立起一行。
10. 不建議用 new 建構 Number、String、Boolean、Object(改用 {})、Array(改用 [])。
11. 陣列元素之間的逗號後保留一個空格。
12. 不要用 JavaScript/JSON 保留字當作命名,這在 IE 中容易出錯。保留關鍵字包含 break、case、catch、continue、default、delete、do、else、finally、for、function、if、in、instanceof、new、return、switch、this、throw、try、typeof、var、void、while、with,關鍵詞包含 abstract、boolean、byte、char、class、const、debugger、double、enum、export、extends、final、float、goto、implements、import、int、interface、long、native、package、private、protected、public、short、static、super、synchronized、throws、transient、volatile。
13. 換行串接字串時建議用 +,不要用 \。
14. 提示訊息要具體、能直接定位問題。例如該寫「該用戶不存在」,而不是「後台返回數據有誤」或「網絡超時」這種概括描述。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved