制定目的
為提升團隊協作效率、方便後端人員添加功能與前端後期優化維護,並產出高質量的文檔,特制定本規範。規範一經確認,前端開發人員必須依此進行頁面開發;文檔若有不合適之處,應及時提出,經討論後方可修改。
符合 Web 標準、語義化 HTML、結構/表現/行為分離、兼容性良好。性能方面,代碼要求簡潔有序,盡可能降低服務器負載,保證最快的解析速度。
1. html、css、js、images 文件均歸檔至約定目錄中。
2. HTML 文件採用英文命名,後綴 .htm;同時將對應界面稿放在同目錄,若設計稿為中文名請重命名為與 HTML 同名,方便後端查找。
3. CSS 文件英文命名,後綴 .css;共用樣式統一為 base.css,首頁為 index.css,其餘按實際模塊命名。
4. JS 文件英文命名,後綴 .js;共用腳本統一為 common.js,其餘按實際模塊命名。
1. 文檔類型統一為 HTML5 聲明 <!DOCTYPE html>;編碼統一,並利用 IDE 實現層次分明的縮進。
2. 非特殊情況,樣式文件必須外鏈至 <head> 中;JavaScript 文件必須外鏈至頁面底部。
3. 引入外部文件時省略默認類型聲明:
<link rel="stylesheet" href="..." />
<style>...</style>
<script src="..."></script>
4. 引入 JS 庫時,文件名須含庫名、版本號及是否壓縮版,例如 jquery-1.4.1.min.js;引入插件則為「庫名+插件名」,例如 jQuery.cookie.js。
5. 標籤、屬性與屬性名一律小寫,可含下劃線與數字;所有標籤必須閉合,包括 <br />、<hr />;屬性值必須用雙引號包裹。
6. 充分利用無兼容問題的原生標籤,如 span、em、strong、optgroup、label 等。需要自定義屬性時,先確認有沒有合適的現成標籤可用;若無,請以 data- 為前綴,避免使用其他命名方式。
7. 語義化:標題按重要性使用 h*(同一頁面只能有一個 h1),段落用 p,列表用 ul;內聯元素中不可嵌套塊級元素。
8. 盡可能減少 div 嵌套。例如 <div class="box"><div class="welcome">歡迎訪問,您的用戶名是<div class="name">用戶名</div></div></div> 完全可以寫成 <div class="box"><p>歡迎訪問,您的用戶名是<span>用戶名</span></p></div>。
9. 書寫鏈接地址時應避免重定向,目錄頁 URL 結尾要補上「/」。
10. 盡量避免使用行內 style 屬性。
11. 含描述性表單元素(input、textarea)必須添加 label,關聯 id 與 for。
12. 能以背景形式呈現的圖片,盡量寫入 CSS。
13. 重要圖片必須加 alt;重要元素與可能被截斷的元素加上 title。
14. 為區塊代碼及重要功能(如循環)加上注釋,方便後端添加功能。
15. 特殊符號盡可能用實體碼替代,如 <、>、 、» 等。
16. 書寫時需考慮向後擴展性。
1. 文件編碼統一。
2. 協作分工:由一人先根據模塊與頁面相似度搭好框架文件,分配給其他人實現內部結構、表現與行為。共用的 base.css 由一人統一維護,包含 reset 與頭尾樣式,所有人必須引入,且不可隨意修改。
3. id 唯一且為父級,class 可重複且為子級。因此 id 只用在大模塊上,class 用於高複用率的元素與子級。
4. 為 JavaScript 預留的鉤子,命名以 js_ 開頭,如 js_hide、js_show。
5. class 與 id 命名:header、footer、wrapper、left、right 等框架名稱由統一分配;其餘用小寫英文、數字與下劃線組合,如 i_comment、fontred、width200。避免漢語拼音,盡量使用簡易單詞組合,做到語義化、簡明化。
6. 規避命名衝突的兩種方式:(a)從屬寫法,如 <div id="mainnav"><div class="firstnav">,樣式寫成 #mainnav .firstnav;(b)取父級名稱的一部分組合,如 class="main_firstnav",樣式寫成 .main_firstnav。高複用率的命名請以自己代號加下劃線開頭,如 i_clear。
7. 屬性書寫順序建議為:布局定位屬性 → 自身屬性 → 文本屬性 → 其他。布局定位包括 display、list-style、position(及 top/right/bottom/left)、float、clear、visibility、overflow;自身屬性包括 width、height、margin、padding、border、background;文本屬性包括 color、font、text-decoration、text-align、vertical-align、white-space、content。
8. 書寫前先考慮樣式復用率。
9. 善用繼承減少代碼量。例如 <ul class="list"><li>標題<span>日期</span></li></ul>,只需 ul.list li{position:relative} 與 ul.list li span{position:absolute; right:0} 即可讓日期靠右。
10. 樣式表中的中文字體名請轉為 Unicode 轉義碼,避免編碼錯誤造成亂碼。
11. 背景圖片盡可能使用 sprite 技術減少請求;考慮多人協作,sprite 按模塊製作。
12. 使用 table 時(盡量避免),不要用 width、height、cellspacing、cellpadding 等屬性直接定義表現,應利用 thead、tr、th、td、tbody、tfoot、colgroup、scope 等結構性標籤分離結構與樣式。
13. 不要用 <meta http-equiv="X-UA-Compatible" content="IE=7" /> 去兼容舊版 IE。
14. 使用 PNG 時要求為 png-8 格式;若影響質量或含半透明效果,需為 IE6 單獨定義背景(_background:none; 搭配 AlphaImageLoader 濾鏡)。
15. 避免使用兼容性有問題的屬性,如 text-shadow 及部分 CSS3 屬性。
16. 減少使用影響性能的屬性,如過多的 position:absolute 與 float。
17. 大區塊樣式必須加注釋,小區塊適量加註釋。
18. 代碼縮進與格式建議單行書寫,後期統一處理。
1. 編碼統一;每行代碼結尾必須加分號。原則上所有功能依項目需求原生開發,避免直接套用網上代碼造成的污染與衝突。
2. 庫引入:原則上僅引入 jQuery;若需第三方庫,須與團隊討論決定。
3. 變量採用駝峰式命名,原生 JavaScript 變量首字母小寫,如 iTaoLun;jQuery 變量首字符為下劃線,如 _iTaoLun。變量集中聲明,避免全局變量。
4. 類名首字母大寫駝峰式,如 ITaoLun。
5. 函數名首字母小寫駝峰式,如 iTaoLun()。
6. 命名語義化,盡量使用英文單詞或其縮寫。
7. 避免使用存在兼容性或消耗資源的方法,如 eval()、innerText。
8. 後期優化時,JS 非注釋類中文字符須轉為 Unicode 編碼,避免亂碼。
9. 代碼結構清晰,加適量注釋,提高函數復用率。
10. 注重與 HTML 分離,減少 reflow,關注性能。
1. 頁面元素類圖片放入 img 文件夾,測試用圖放入 img/demoimg。
2. 格式僅限 gif、png、jpg。
3. 命名全部使用小寫字母、數字與下劃線組合,不得含中文、空格或特殊字符;分頭尾兩部分並用下劃線隔開,如 ad_left01.gif、btn_submit.gif。
4. 在保證視覺效果的前提下選擇最小的格式與質量,以縮短加載時間。
5. 盡量避免半透明 PNG(若使用請參考 CSS 規範相關說明)。
6. 運用 sprite 集中小背景圖與圖標以減少請求,但務必在對應的 psd 源文件中劃好參考線並存檔。
1. HTML 注釋格式為 <!--這兒是注釋-->,「--」只能出現在注釋的起止位置,不可出現在注釋內容中。
2. CSS 注釋格式為 /* 這兒是注釋 */。
3. JavaScript 單行注釋用 // 這兒是單行注釋,多行注釋用 /* */。
編輯器可任選 Aptana、Dw、Vim 等,但須遵循三條原則:不可用 IDE 的視圖模式「畫」代碼;不可使用 IDE 生成的功能代碼;編碼必須格式化(如縮進)。
測試工具:前期開發測 Firefox、IE6、IE7、IE8;後期優化加入 Opera、Chrome、Safari。建議順序:Firefox → IE7 → IE8 → IE6 → Opera → Chrome → Safari,並安裝 firebug 與 IE Tab Plus 之類的輔助插件。
1. 開發過程中嚴格按分工完成頁面,提高 CSS 復用率,避免重複開發。
2. 減少冗餘代碼,寫所有人都能看懂的代碼。簡潔易懂是一種美德——為用戶著想,也為服務器著想。