網(wǎng)站制作規(guī)范目的
為提高團(tuán)隊(duì)協(xié)作效率,便于后臺(tái)人員添加功能及前端后期優(yōu)化維護(hù),輸出高質(zhì)量的文檔, 特制訂此文檔。本規(guī)范文檔一經(jīng)確認(rèn),前端開發(fā)人員必須按本文檔規(guī)范進(jìn)行前臺(tái)頁(yè)面開發(fā),本文檔如有不對(duì)或者不合適的地方請(qǐng)及時(shí)提出。經(jīng)討論決定后方可更改。
網(wǎng)站制作基本準(zhǔn)則
符合web標(biāo)準(zhǔn),語(yǔ)義化html,結(jié)構(gòu)表現(xiàn)行為分離, 兼容性優(yōu)良。 頁(yè)面性能方面,代碼要求簡(jiǎn)潔明了有序,盡可能的減小服務(wù)器負(fù)載,保證最快的解析速度。
網(wǎng)站制作文件規(guī)范
1、html, css, js, images文件均歸檔至<系統(tǒng)開發(fā)規(guī)范>約定的目錄中;
2、html文件命名: 英文命名, 后綴.htm。 同時(shí)將對(duì)應(yīng)界面稿放于同目錄中,若界面稿命名為中文,請(qǐng)重命名與html文件同名, 以方便后端添加功能時(shí)查找對(duì)應(yīng)頁(yè)面;
3、css文件命名: 英文命名, 后綴.css. 共用style.css,其他頁(yè)面依實(shí)際模塊需求命名;
4、 Js文件命名: 英文命名, 后綴.js. 共用common.js, 其他依實(shí)際模塊需求命名.
網(wǎng)站建設(shè)html書寫規(guī)范
1、文檔類型聲明及編碼: 統(tǒng)一為html5聲明類型; 編碼統(tǒng)一為, 書寫時(shí)利用IDE實(shí)現(xiàn)層次分明的縮進(jìn);
2、非特殊情況下樣式文件必須外鏈至...之間;非特殊情況下JavaScript文件必須外鏈至頁(yè)面底部;
3、引入樣式文件或JavaScript文件時(shí), 須略去默認(rèn)類型聲明, 寫法如下:
...
<!-- Inject Script Filtered -->
4、引入JS庫(kù)文件, 文件名須包含庫(kù)名稱及版本號(hào)及是否為壓縮版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式為庫(kù)名稱+插件名稱, 比如jQuery.cookie.js;
5、 所有編碼均遵循xhtml標(biāo)準(zhǔn), 標(biāo)簽 & 屬性 & 屬性命名 必須由小寫字母及下劃線數(shù)字組成, 且所有標(biāo)簽必須閉合, 包括 br, hr等; 屬性值必須用雙引號(hào)包括;
6、充分利用無(wú)兼容性問(wèn)題的html自身標(biāo)簽, 比如span, em, strong, optgroup, label,等等; 需要為html元素添加自定義屬性的時(shí)候, 首先要考慮下有沒有默認(rèn)的已有的合適標(biāo)簽去設(shè)置, 如果沒有, 可以使用須以"data-"為前綴來(lái)添加自定義屬性,避免使用"data:"等其他命名方式;
7、 語(yǔ)義化html, 如 標(biāo)題根據(jù)重要性用h*(同一頁(yè)面只能有一個(gè)h1), 段落標(biāo)記用p, 列表用ul, 內(nèi)聯(lián)元素中不可嵌套塊級(jí)元素;
8、在頁(yè)面中盡量避免使用style屬性,即style="…";
9、能以背景形式呈現(xiàn)的圖片, 盡量寫入css樣式中;
10、 重要圖片必須加上alt屬性; 給重要的元素和截?cái)嗟脑丶由蟭itle;
11、給區(qū)塊代碼及重要功能(比如循環(huán))加上注釋, 方便后臺(tái)添加功能;
12、特殊符號(hào)使用: 盡可能使用代碼替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等;
13、 書寫頁(yè)面過(guò)程中, 請(qǐng)考慮向后擴(kuò)展性;
14、class & id 參見 css書寫規(guī)范.