天天看點

WEB前端開發規範文檔(範文)

無論是從技術角度還是開發視角,對于web前端開發規範文檔都有一定規範,本文就css3和html5的發展前景總結了一系列的web開發文檔,僅供大家參考。

規範目的

為提高團隊協作效率, 便于背景人員添加功能及前端後期優化維護, 輸出高品質的文檔, 特制訂此文檔. 本規範文檔一經确認, 前端開發人員必須按本文檔規範進行前台頁面開發. 本文檔如有不對或者不合适的地方請及時提出, 經讨論決定後方可更改.

基本準則

符合web标準, 語義化html, 結構表現行為分離, 相容性優良. 頁面性能方面, 代碼要求簡潔明了有序, 盡可能的減小伺服器負載, 保證最快的解析速度.

檔案規範

1. html, css, js, images檔案均歸檔至<系統開發規範>約定的目錄中;

2. html檔案命名: 英文命名, 字尾.htm. 同時将對應界面稿放于同目錄中, 若界面稿命名為中文, 請重命名與html檔案同名, 以友善後端添加功能時查找對應頁面;

3. css檔案命名: 英文命名, 字尾.css. 共用base.css, 首頁index.css, 其他頁面依實際子產品需求命名.;

4. Js檔案命名: 英文命名, 字尾.js. 共用common.js, 其他依實際子產品需求命名.

html書寫規範

1. 文檔類型聲明及編碼: 統一為HTML5聲明類型<!DOCTYPE html>; 編碼統一為<meta charset=”utf-8″ />, 書寫時利用IDE實作層次分明的縮進;

2. 非特殊情況下樣式檔案必須外鍊至<head>…</head>之間;非特殊情況下JavaScript檔案必須外鍊至頁面底部;

3. 引入樣式檔案或JavaScript檔案時, 須略去預設類型聲明, 寫法如下:

<link rel=”stylesheet” href=”…” />

<style>…</style>

<script src=”…”></script>

4. 引入JS庫檔案, 檔案名須包含庫名稱及版本号及是否為壓縮版, 比如jquery-1.4.1.min.js; 引入插件, 檔案名格式為庫名稱+插件名稱, 比如jQuery.cookie.js;

5. 所有編碼均遵循xhtml标準, 标簽 & 屬性 & 屬性命名 必須由小寫字母及下劃線數字組成, 且所有标簽必須閉合, 包括br (<br />), hr(<hr />)等; 屬性值必須用雙引号包括;

6. 充分利用無相容性問題的html自身标簽, 比如span, em, strong, optgroup, label,等等; 需要為html元素添加自定義屬性的時候, 首先要考慮下有沒有預設的已有的合适标簽去設定, 如果沒有, 可以使用須以”data-”為字首來添加自定義屬性,避免使用”data:”等其他命名方式;

7. 語義化html, 如 标題根據重要性用h*(同一頁面隻能有一個h1), 段落标記用p, 清單用ul, 内聯元素中不可嵌套塊級元素;

8. 盡可能減少div嵌套, 如<div class=”box”><div class=”welcome”>歡迎通路XXX, 您的使用者名是<div class=”name”>使用者名</div></div></div>完全可以用以下代碼替代: <div class=”box”><p>歡迎通路XXX, 您的使用者名是<span>使用者名</span></p></div>;

9. 書寫連結位址時, 必須避免重定向,例如:href=”http://itaolun.com/”, 即須在URL位址後面加上“/”;

10. 在頁面中盡量避免使用style屬性,即style=”…”;

11. 必須為含有描述性表單元素(input, textarea)添加label, 如<p>姓名: <input type=”text” id=”name” name=”name” /></p>須寫成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>

12. 能以背景形式呈現的圖檔, 盡量寫入css樣式中;

13. 重要圖檔必須加上alt屬性; 給重要的元素和截斷的元素加上title;

14. 給區塊代碼及重要功能(比如循環)加上注釋, 友善背景添加功能;

15. 特殊符号使用: 盡可能使用代碼替代: 比如 <(<) & >(&gt;) & 空格( ) & ?(?) 等等;

16. 書寫頁面過程中, 請考慮向後擴充性;

17. class & id 參見 css書寫規範.

css書寫規範

1. 編碼統一為utf-8;

2. 協作開發及分工: i會根據各個子產品, 同時根據頁面相似程式, 事先寫好大體架構檔案, 配置設定給前端人員實作内部結構&表現&行為; 共用css檔案base.css由i書寫, 協作開發過程中, 每個頁面請務必都要引入, 此檔案包含reset及頭部底部樣式, 此檔案不可随意修改;

3. class與id的使用: id是唯一的并是父級的, class是可以重複的并是子級的, 是以id僅使用在大的子產品上, class可用在重複使用率高及子級中; id原則上都是由我分發架構檔案時命名的, 為JavaScript預留鈎子的除外;

4. 為JavaScript預留鈎子的命名, 請以 js_ 起始, 比如: js_hide, js_show;

5. class與id命名: 大的架構命名比如header/footer/wrapper/left/right之類的在2中由i統一命名.其他樣式名稱由 小寫英文 & 數字 & _ 來組合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 盡量使用簡易的單詞組合; 總之, 命名要語義化, 簡明化.

6. 規避class與id命名(此條重要, 若有不明白請及時與i溝通):

a, 通過從屬寫法規避, 示例見d;

b, 取父級元素id/class命名部分命名, 示例見d;

c, 重複使用率高的命名, 請以自己代号加下劃線起始, 比如i_clear;

d, a,b兩條, 适用于在2中已建好架構的頁面, 如, 要在2中已建好架構的頁面代碼<div id=”mainnav”></div>中加入新的div元素,

按a命名法則: <div id=”mainnav”><div class=”firstnav”>…</div></div>,

樣式寫法:  #mainnav  .firstnav{…….}

按b命名法則: <div id=”mainnav”><div class=”main_firstnav”>…</div></div>,

樣式寫法:  .main_firstnav{…….}

7. css屬性書寫順序, 建議遵循 布局定位屬性–>自身屬性–>文本屬性–>其他屬性. 此條可根據自身習慣書寫, 但盡量保證同類屬性寫在一起. 屬性列舉: 布局定位屬性主要包括: margin & padding & float(包括clear) & position(相應的 top,right,bottom,left) & display & visibility & overflow等; 自身屬性主要包括: width  &  height  &  background  &  border; 文本屬性主要包括: font & color & text-align & text-decoration & text-indent等;其他屬性包括: list-style(清單樣式) & vertical-vlign & cursor & z-index(層疊順序)  & zoom等. 我所列出的這些屬性隻是最常用到的, 并不代表全部;

8. 書寫代碼前, 考慮并提高樣式重複使用率;

9. 充分利用html自身屬性及樣式繼承原理減少代碼量, 比如:

<ul class=”list”><li>這兒是标題清單<span>2010-09-15</span></ul>

定義

ul.list li{position:relative}  ul.list li span{position:absolute; right:0}

即可實作日期居右顯示

10. 樣式表中中文字型名, 請務必轉碼成unicode碼, 以避免編碼錯誤時亂碼;

11. 背景圖檔請盡可能使用sprite技術, 減小http請求, 考慮到多人協作開發, sprite按子產品制作;

12. 使用table标簽時(盡量避免使用table标簽), 請不要用width/ height/cellspacing/cellpadding等table屬性直接定義表現, 應盡可能的利用table自身私有屬性分離結構與表現, 如thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法: table{border:0;margin:0;border-collapse:collapse;} table th, table td{padding:0;} , base.css檔案中我會初始化表格樣式)

13. 杜絕使用<meta http-equiv=”X-UA-Compatible” content=”IE=7″ /> 相容ie8;

14. 用png圖檔做圖檔時, 要求圖檔格式為png-8格式,若png-8實在影響圖檔品質或其中有半透明效果, 請為ie6單獨定義背景:

_background:none;_filter:progid:DXImageTransForm.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);

15. 避免相容性屬性的使用, 比如text-shadow || css3的相關屬性;

16. 減少使用影響性能的屬性, 比如position:absolute || float ;

17. 必須為大區塊樣式添加注釋, 小區塊适量注釋;

18. 代碼縮進與格式: 建議單行書寫, 可根據自身習慣, 後期優化i會統一處理;

JavaScript書寫規範

1. 檔案編碼統一為utf-8, 書寫過程過, 每行代碼結束必須有分号; 原則上所有功能均根據XXX項目需求原生開發, 以避免網上down下來的代碼造成的代碼污染(沉冗代碼 || 與現有代碼沖突 || …);

2. 庫引入: 原則上僅引入jQuery庫, 若需引入第三方庫, 須與團隊其他人員讨論決定;

3. 變量命名: 駝峰式命名. 原生JavaScript變量要求是純英文字母, 首字母須小寫, 如iTaoLun;

jQuery變量要求首字元為’_’, 其他與原生JavaScript 規則相同, 如: _iTaoLun;

另, 要求變量集中聲明, 避免全局變量.

4. 類命名: 首字母大寫, 駝峰式命名. 如 ITaoLun;

5. 函數命名: 首字母小寫駝峰式命名. 如iTaoLun();

6. 命名語義化, 盡可能利用英文單詞或其縮寫;

7. 盡量避免使用存在相容性及消耗資源的方法或屬性, 比如eval() & innerText;

8. 後期優化中, JavaScript非注釋類中文字元須轉換成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. 運用css sprite技術集中小的背景圖或圖示, 減小頁面http請求, 但注意, 請務必在對應的sprite psd源圖中劃參考線, 并儲存至img目錄下.

注釋規範

1. html注釋: 注釋格式 <!–這兒是注釋–>, ’–’隻能在注釋的始末位置,不可置入注釋文字區域;

2. css注釋: 注釋格式 ;

3. JavaScript注釋, 單行注釋使用’//這兒是單行注釋’ ,多行注釋使用 ;

開發及測試工具約定

建議使用Aptana || Dw || Vim , 亦可根據自己喜好選擇, 但須遵循如下原則:

1. 不可利用IDE的視圖模式’畫’代碼;

2. 不可利用IDE生成相關功能代碼, 比如Dw内置的一些功能js;

3. 編碼必須格式化, 比如縮進;

測試工具: 前期開發僅測試FireFox & IE6 & IE7 & IE8 , 後期優化時加入Opera & Chrome & Safari;

建議測試順序: FireFox–>IE7–>IE8–>IE6–>Opera–>Chrome–>Safari, 建議安裝firebug及IE Tab Plus插件.

其他規範

1. 開發過程中嚴格按分工完成頁面, 以提高css複用率, 避免重複開發;

2. 減小沉冗代碼, 書寫所有人都可以看的懂的代碼. 簡潔易懂是一種美德. 為使用者着想, 為伺服器着想

繼續閱讀