web前端開發(fā)規(guī)范_第1頁
web前端開發(fā)規(guī)范_第2頁
web前端開發(fā)規(guī)范_第3頁
web前端開發(fā)規(guī)范_第4頁
web前端開發(fā)規(guī)范_第5頁
已閱讀5頁，還剩18頁未讀， 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明：本文檔由用戶提供并上傳，收益歸屬內(nèi)容提供方，若內(nèi)容存在侵權(quán)，請進行舉報或認領(lǐng)

文檔簡介

1、Web前端開發(fā)規(guī)范手冊一、規(guī)范目的1.1 概述 . 1二、文件規(guī)范2.1 文件命名規(guī)則.12.2 文件存放位置.22.3 html 書寫規(guī)范.22.4 css 書寫規(guī)范.72.5 JavaScript 書寫規(guī)范.122.6 圖片規(guī)范.192.7 注釋規(guī)范.20 2.8 css 瀏覽器兼容.21一、規(guī)范目的1.1 概述為提高團隊協(xié)作效率, 便于后臺人員添加功能及前端后期優(yōu)化維護, 輸出高質(zhì)量的文檔, 特制訂此文檔. 本規(guī)范文檔一經(jīng)確認,&

2、#160;前端開發(fā)人員必須按本文檔規(guī)范進行前臺頁面開發(fā). 本文檔如有不對或者不合適的地方請及時提出, 經(jīng)討論決定后可以更改此文檔.二、文件規(guī)范2.1文件命名規(guī)則文件夾和文件名一律全部用小寫英文單詞，禁止出現(xiàn)簡拼、拼音、數(shù)字、無意義的命名，英文單詞盡量使用一個進行描述，簡潔易懂；多個單詞用駝峰命名法。2.2 文件存放位置cn 存放中文 HTML 文件en 存放英文 HTML 文件flash 存放 Flash 文件images 存放圖片文件imagestudio

3、0;存放 PSD 源文件flashstudio 存放 flash 源文件inc 存放include 文件library 存放 DW 庫文件media 存放多媒體文件project 存放工程項目資料temp 存放客戶原始資料js 存放 JavaScript 腳本css 存放 CSS 文件 2.3 html 書寫規(guī)范 為每個HTML頁面的第一行添加標準模式（standard mode）的聲明，確保在每

4、個瀏覽器中擁有一致的展現(xiàn)。· <!DOCTYPE html> 文檔類型聲明統(tǒng)一為HTML5聲明類型，編碼統(tǒng)一為UTF-8。<meta charset="UTF-8"><HEAD>中添加信息。<meta name="author" content="smilekang.cool">/作者<meta name="description" content="hello">/網(wǎng)頁描述<meta name="keywor

5、ds" content="a,b,c">/關(guān)鍵字,“，”分隔<meta http-equiv="expires" content="Wed, 26 Feb 1997 08：21：57 GMT">/設(shè)定網(wǎng)頁的到期時間。一旦網(wǎng)頁過期，必須到服務(wù)器上重新調(diào)閱<meta http-equiv="Pragma" content="no-cache">/禁止瀏覽器從本地機的緩存中調(diào)閱頁面內(nèi)容<meta http-equiv="Window-target

6、" content="_top">/用來防止別人在框架里調(diào)用你的頁面<meta http-equiv="Refresh" content="5;URL= 網(wǎng)頁搜索機器人向?qū)АＳ脕砀嬖V搜索機器人哪些頁面需要索引，哪些頁面不需要索引<meta name="robots" content="none">/content的參數(shù)有all,none,index,noindex,follow,nofollow，默認是all<link rel="Shortcut Icon

7、" href="favicon.ico">/收藏圖標<meta http-equiv="Cache-Control" content="no-cache, must-revalidate">/網(wǎng)頁不會被緩存IE支持通過特定<meta>標簽來確定繪制當前頁面所應(yīng)該采用的IE版本。除非有強烈的特殊需求，否則最好是設(shè)置為edgemode ，從而通知IE采用其所支持的最新的模式。<meta http-equiv="X-UA-Compatible" content="I

8、E=Edge"> 非特殊情況下CSS樣式文件外鏈至HEAD之間，JAVASCRIPT文件外鏈至頁面底部。<!DOCTYPE html><html><head> <link rel="stylesheet" href="css/main.css"></head><body> <!- 邏輯代碼 -> <!- 邏輯代碼底部 -> <script src="lib/jquery/jquery-2.1.1.min.js">

9、</script></body></html>引入JAVASCRIPT庫文件，文件名須包含庫名稱及版本號及是否為壓縮版。jQuery-1.8.3.min.js引入JAVASCRIPT插件, 文件名格式為庫名稱+.+插件名稱。jQuery.cookie.js HTML屬性應(yīng)當按照以下給出的順序依次排列，來確保代碼的易讀性。Classid 、 namedata-*src、for、 type、 hreftitle、altaria-*、 role避免使用中文拼音盡量簡易并要求語義化。CLASS -> nHeadTitle -> CLASS遵循小駝峰命名法

10、（little camel-case）ID -> n_head_title -> ID遵循名稱+_NAME -> N_Head_Title -> NAME屬性命名遵循首個字母大寫+_<div class="nHeadTitle" id="n_head_title" name="N_Head_Title"></div>當JAVASCRIPT獲取單個元素時，通常使用document.getElementById來獲取dom元素，document.getElementById兼容所有瀏覽器，但

11、IE瀏覽器會混淆元素的ID和NAME屬性，所以要區(qū)分ID和NAME命名。<input type="text" name="test"><div id="test"></div><button onclick="alert(document.getElementById('test').tagName)"></button><!- ie6下為INPUT -> 特殊符號應(yīng)使用轉(zhuǎn)意符。< -> <> ->

12、 >空格 -> 含有描述性表單元素（INPUT，TEXTAREA）添加LABEL。<p> <label for="test">測試</label> <input type="text" id="test" /></p> 多用無兼容性問題的HTML內(nèi)置標簽,比如span、em、strong、optgroup、label等,需要自定義html標簽屬性時，首先考慮是否存在已有的合適標簽可替換，如果沒有,可使用須以“data-”為前綴來添加自定義屬性，避免使用其他命名方式

13、。 語義化HTML。 盡可能減少<DIV>嵌套。 書寫鏈接地址時避免重定向。href=" /即在URL地址后面加“/” HTML中對于屬性的定義，確保全部使用雙引號，絕不要使用單引號2.4 css 書寫規(guī)范 為了欺騙W3C的驗證工具,可將代碼分為兩個文件，一個是針對所有瀏覽器,一個只針對IE。即將所有符合W3C的代碼寫到一個文件中,而一些IE中必須而又不能通過W3C驗證的代碼（如:cursor:hand;）放到另一個文件中，再用下面的方法導入。<!- 放置所有瀏覽器樣式-><link rel="stylesheet" type=&qu

14、ot;text/css" href=""><!- 只放置IE必須，而不能通過w3c的-><!-if IE <link rel="stylesheet" href=""><!endif-> CSS樣式新建或修改盡量遵循以下原則。根據(jù)新建樣式的適用范圍分為三級：全站級、產(chǎn)品級、頁面級。盡量通過繼承和層疊重用已有樣式。不要輕易改動全站級CSS。改動后，要經(jīng)過全面測試。 CSS屬性顯示順序。顯示屬性元素位置元素屬性元素內(nèi)容屬性CSS書寫順序。.header /* 顯示屬性 */ dis

15、play | visibility list-style position top | right | bottom | left z-index clear float/* 自身屬性 */ width max-width | min-width height max-height | min-height overflow | clip margin padding outline border background/* 文本屬性 */ color font text-overflow text-align text-indent line-height white-space vertic

16、al-align cursor content ;兼容多個瀏覽器時，將標準屬性寫在底部。-moz-border-radius: 15px; /* Firefox */-webkit-border-radius: 15px; /* Safari和Chrome */border-radius: 15px; /* Opera 10.5+, 以及使用了IE-CSS3的IE瀏覽器 */標準屬性 使用選擇器時，命名比較短的詞匯或者縮寫的不允許直接定義樣式。.hd,.bd,.td;/如這些命名可用上級節(jié)點進行限定。.recommend-mod .hd多選擇器規(guī)則之間換行，即當樣式針對多個選擇器時每個選擇器占

17、一行。button.btn,input.btn,inputtype="button" ;優(yōu)化CSS選擇器。#header a color: #444; ;/*CSS選擇器是從右邊到左邊進行匹配*/瀏覽器將檢查整個文檔中的所有鏈接和每個鏈接的父元素，并遍歷文檔樹去查找ID為header的祖先元素，如果找不到header將追溯到文檔的根節(jié)點，解決方法如下。避免使用通配規(guī)則和相鄰兄弟選擇符、子選擇符,、后代選擇符、屬性選擇符等選擇器不要限定id選擇符，如div#header（提權(quán)的除外）不要限定類選擇器，如ul.recommend（提權(quán)的除外）不要使用 ul li a 這樣長的選

18、擇符避免使用標簽子選擇符，如#header > li > a 使用z-index屬性盡量z-index的值不要超過150（通用組的除外），頁面中的元素內(nèi)容的z-index不能超過10（提示框等模塊除外但維持在150以下），不允許直接使用（9999999）之間大值。 盡量避免使用CSS Hperty:value; /* 所有瀏覽器 */+property:value; /* IE7 */_property:value; /* IE6 */*property:value; /* IE6/7 */property:value9; /* IE6/7/8/9，即所有IE瀏覽器

19、*/* html selector ; /* IE6 */*:first-child+html selector ; /* IE7 */html>body selector ; /* 非IE6 */-moz-document url-prefix() ; /* firefox */media all and (-webkit-min-device-pixel-ratio:0) ; /* saf3+/chrome1+ */media all and (-webkit-min-device-pixel-ratio:10000),not all and (-webkit-min-device-

20、pixel-ratio:0) ; /* opera */media screen and (max-device-width: 480px) ; /* iPhone/mobile webkit */ 避免使用低效的選擇器。body > * ;ul > li > a ;#footer > h3 ;ul#top_blue_nav ;#searbar span.submit a ; /* 反面示例 */ 六個不要三個避免一個使用。不要在標簽上直接寫樣式不要在CSS中使用expression不要在CSS中使用import不要在CSS中使用!important不要在CSS中使用“

21、*”選擇符不要將CSS樣式寫為單行避免使用filter避免使用行內(nèi)（inline）樣式避免使用“*”設(shè)置margin: 0; padding: 0;使用after或overflow的方式清浮動 減少使用影響性能的屬性。position:absolute;float:left;/如這些定位或浮動屬性減少在CSS中使用濾鏡表達式和圖片repeat,尤其在body當中,渲染性能極差, 如果需要用repeat的話,圖片的寬或高不能少于8px。2.5 javaScript書寫規(guī)范 命名規(guī)范。常量名 全部大寫并單詞間用下劃線分隔 如：CSS_BTN_CLOSE、TXT_LOADING對象的屬性或方法名 小

22、駝峰式（little camel-case） 如：init、bindEvent、updatePosition 示例：Dtotype = init: function () , bindEvent: function () , updatePosition: function () ;類名（構(gòu)造器） ->小駝峰式但首字母大寫 ->如：Current、DefaultConfig函數(shù)名 ->小駝峰式 ->如：current()、defaultConfig()變量名 ->小駝峰式 ->如：current、defaultConfig私有變量名 -&g

23、t;小駝峰式但需要用_開頭 ->如：_current、_defaultConfig變量名的前綴 ->續(xù) 代碼格式。"()"前后需要跟空格"="前后需要跟空格","后面需要跟空格JSON對象需格式化對象參數(shù)if、while、for、do語句的執(zhí)行體用""括起來""格式如下。if (a=1) /代碼;避免額外的逗號。var arr = 1,2,3,;for-in循環(huán)體中必須用hasOwnProperty方法檢查成員是否為自身成員，避免來自原型鏈上的污染。長語句可考慮斷行。TEMPL_SO

24、NGLIST.replace('TABLE', da'results') .replace('PREV_NUM', prev) .replace('NEXT_NUM', next) .replace('CURRENT_NUM', current) .replace('TOTAL_NUM', da.page_total);為了避免和JSLint的檢驗機制沖突，“.”或“+”這類操作符放在行尾。TEMPL_SONGLIST.replace('TABLE', da'results&

25、#39;). replace('PREV_NUM', prev). replace('NEXT_NUM', next). replace('CURRENT_NUM', current). replace('TOTAL_NUM', da.page_total);如果模塊代碼中，使用其它全局變量想跳過JSLint的檢查，可以在該文件中加入/*global*/聲明。/*global alert: true, console: true, top: true, setTimeout: true */使用嚴格的條件判斷符。用=代替=，用!=

26、代替!=，避免掉入=造成的陷阱在條件判斷時，這樣的一些值表示false。nullundefined與null相等字符串''數(shù)字0NaN在=時，則會有一些讓人難以理解的陷阱。(function () var undefined; undefined = null; / true 1 = true; /true 2 = true; / false 0 = false; / true 0 = '' / true NaN = NaN;/ false = false; / true = !; / true)();對于不同類型的 = 判斷，有這樣一些規(guī)則，順序自上而下：un

27、defined與null相等一個是number一個是string時，會嘗試將string轉(zhuǎn)換為number嘗試將boolean轉(zhuǎn)換為number0或1嘗試將Object轉(zhuǎn)換成number或string而這些取決于另外一個對比量，即值的類型，所以對于0、空字符串的判斷，建議使用=。=會先判斷兩邊的值類型，類型不匹配時為false。 下面類型的對象不建議用new構(gòu)造。new Numbernew Stringnew Booleannew Object /用代替new Array /用代替引用對象成員用p代替obj"prop"，除非屬性名是變量。 從number到st

28、ring的轉(zhuǎn)換。/* 推薦寫法*/var a = 1;typeof(a); /"number"console.log(a); /1var aa=a+''typeof(aa); /"string"console.log(aa); /'1'/* 不推薦寫法*/new String(a)或a.toString()從string到number的轉(zhuǎn)換，使用parseInt，必須顯式指定第二個參數(shù)的進制。/* 推薦寫法*/var a = '1'var aa = parseInt(a,10);typeof(a); /&q

29、uot;string"console.log(a); /'1'typeof(aa); /"number"console.log(aa); /1從float到integer的轉(zhuǎn)換。/* 推薦寫法*/Math.floor/Math.round/Math.ceil/* 不推薦寫法*/parseInt字符串拼接應(yīng)使用數(shù)組保存字符串片段，使用時調(diào)用join方法。避免使用+或+=的方式拼接較長的字符串，每個字符串都會使用一個小的內(nèi)存片段，過多的內(nèi)存片段會影響性能。/*推薦的拼接方式array的push、join*/var str=, list='測試A

30、','測試B'for (var i=0 , len=list.length; i < len; i+) str.push( '<div>'+ listi + '</div>');console.log(str.join(''); /<div>測試A</div><div>測試B</div>/* 不推薦的拼接方式+=*/var str = '', list='測試A','測試B'for (var i =

31、 0, len = list.length; i< len; i+) str+='<div>' + listi + '</div>'console.log(str); /<div>測試A</div><div>測試B</div> 盡量避免使用存在兼容性及消耗資源的方法或?qū)傩浴２灰褂脀ith，void，evil，eval_r，innerText 注重HTML分離, 減小reflow, 注重性能。2.6圖片規(guī)范 命名應(yīng)用小寫英文、數(shù)字、_組合，便于團隊其他成員理解。header_btn.g

32、ifheader_btn2.gif 頁面元素類圖片均放入img文件夾,測試用圖片放于img/testimg文件夾，psd源圖放入img/psdimg文件夾。 圖片格式僅限于gif、png、jpg等。用png圖片做圖片時,要求圖片格式為png-8格式,若png-8實在影響圖片質(zhì)量或其中有半透明效果,請為ie-6單獨定義背景，并盡量避免使用半透明的png圖片。 背景圖片請盡可能使用sprite技術(shù), 減小http請求。2.7注釋規(guī)范 JAVASCRIPT、CSS文件注釋需要標明作者、文件版本、創(chuàng)建/修改時間、重大版本修改記錄、函數(shù)描述、文件版本、創(chuàng)建或者修改時間、功能、作者等信息。/* * 注釋塊

33、 */中間可添加如下信息file 文件名addon 把一個函數(shù)標記為另一個函數(shù)的擴張，另一個函數(shù)的定義不在源文件中argument 用大括號中的自變量類型描述一個自變量author 函數(shù)/類作者的姓名base 如果類是繼承得來，定義提供的類名稱class 用來給一個類提供描述，不能用于構(gòu)造器的文檔中constructor 描述一個類的構(gòu)造器deprecated 表示函數(shù)/類已被忽略exception 描述函數(shù)/類產(chǎn)生的一個錯誤exec extends 表示派生出當前類的另一個類fileoverview 表示文檔塊將用于描述當前文件，這個標簽應(yīng)該放在其它任何標簽之前final 指出函數(shù)/類ign

34、ore 讓jsdoc忽視隨后的代碼link 類似于link標簽，用于連接許多其它頁面member 定義隨后的函數(shù)為提供的類名稱的一個成員param 用大括號中的參數(shù)類型描述一個參數(shù)private 表示函數(shù)/類為私有，不應(yīng)包含在生成的文檔中requires 表示需要另一個函數(shù)/類return 描述一個函數(shù)的返回值see 連接到另一個函數(shù)/類throws 描述函數(shù)/類可能產(chǎn)生的錯誤type 指定函數(shù)/成員的返回類型version 函數(shù)/類的版本號 2.8 css瀏覽器兼容  CSS hack一、標識區(qū)別:區(qū)別 IE6,IE7,IE8,FF。1. IE 都能識別* ;&

35、#160;標準瀏覽器(如 FF)不能識別*;2. IE6能識別*,但不能識別 !important; IE6在樣式前面加_3. IE7能識別*,也能識別!important;4.IE8能識別9例如:background:red 9;5. firefox 不能識別*,但能識別!important;1.IE6和 firefox 的區(qū)別:background:orange;*background:blue;意思就是火狐瀏覽器的背景顏色是橙色,而 IE 瀏覽器的背景色是藍色.2. IE6和 IE7的區(qū)別:backgroun

36、d:green !important;background:blue;意思指的是:IE7的背景顏色是綠色,IE6的背景顏色是藍色3. IE7和 FF 的區(qū)別:background:orange; *background:green;意思指的是:火狐瀏覽器的背景顏色是橙色,而 IE7的背景顏色是綠色4. FF,IE7,IE6的區(qū)別:background:orange;*background:green !important;*background:blue;意思是火狐瀏覽器的的背景橙色,IE7瀏覽器的背景顏色是綠色,而 IE6瀏覽器的顏色是藍色.二、實踐建議(1). 開發(fā)平臺的選擇在 Firefox 上編寫 CSS, 同時兼容其他瀏覽器的. 這樣做肯定會比在 IE 做好再到別的瀏覽器兼容來得容易, 

溫馨提示

  • 1. 本站所有資源如無特殊說明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽，若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間，僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理，對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯，并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容，請與我們聯(lián)系，我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論