...
資訊專欄INFORMATION COLUMN
摘要：書寫規(guī)范微軟雅黑網(wǎng)頁制作細(xì)節(jié)區(qū)代碼規(guī)范區(qū)是指代碼的和之間的內(nèi)容。
一、規(guī)范目的
1.1 概述 ..................................................................................................................................... 1
二、文件規(guī)范
2.1 文件命名規(guī)則.........................................................................................................................1
2.2 文件存放位置..........................................................................................................................2
2.3 css 書寫規(guī)范..........................................................................................................................3
2.4 html書寫規(guī)范.........................................................................................................................7
2.5 JavaScript書寫規(guī)范.............................................................................................................11
2.6 圖片規(guī)范...................................................................................................................................12
2.7 注釋規(guī)范...................................................................................................................................13
2.8 css 瀏覽器兼容.......................................................................................................................13
一、規(guī)范目的
1.1 概述
為提高團(tuán)隊(duì)協(xié)作效率, 便于后臺(tái)人員添加功能及前端后期優(yōu)化維護(hù), 輸出高質(zhì)量的文檔, 特制訂此文檔. 本規(guī)范文檔一經(jīng)確認(rèn), 前端開發(fā)人員必須按本文檔規(guī)范進(jìn)行前臺(tái)頁面開發(fā). 本文檔如有不對(duì)或者不合適的地方請(qǐng)及時(shí)提出, 經(jīng)討論決定后可以更改此文檔.
二、文件規(guī)范
2.1 文件命名規(guī)則
文件名稱統(tǒng)一用小寫的英文字母、數(shù)字和下劃線的組合，其中不得包含漢字、空格和特殊字符；命名原則的指導(dǎo)思想一是使得你自己和工作組的每一個(gè)成員能夠方便的理解每一個(gè)文件的意義，二是當(dāng)我們?cè)谖募A中使用“按名稱排例”的命令時(shí)，同一種大類的文件能夠排列在一起，以便我們查找、修改、替換、計(jì)算負(fù)載量等等操作。
a. HTML的命名原則
引文件統(tǒng)一使用index.htm index.html index.asp文件名（小寫）
各子頁命名的原則首先應(yīng)該以欄目名的英語翻譯取單一單詞為名稱。例如：
關(guān)于我們 aboutus
信息反饋 feedback
產(chǎn) 品 product
如果欄目名稱多而復(fù)雜并不好以英文單詞命名，則統(tǒng)一使用該欄目名稱拼音或拼音的首字母表示；
每一個(gè)目錄中應(yīng)該包含一個(gè)缺省的html 文件，文件名統(tǒng)一用index.htm index.html index.asp；
b. 圖片的命名原則
圖片的名稱分為頭尾兩部分，用下劃線隔開，頭部分表示此圖片的大類性質(zhì)
例如：廣告、標(biāo)志、菜單、按鈕等等。
放置在頁面頂部的廣告、裝飾圖案等長(zhǎng)方形的圖片取名： banner
標(biāo)志性的圖片取名為： logo
在頁面上位置不固定并且?guī)в墟溄拥男D片我們?nèi)∶麨?/span> button
在頁面上某一個(gè)位置連續(xù)出現(xiàn)，性質(zhì)相同的鏈接欄目的圖片我們?nèi)∶?/span> menu
裝飾用的照片我們?nèi)∶?/span> pic
不帶鏈接表示標(biāo)題的圖片我們?nèi)∶?/span> title
范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg
鼠標(biāo)感應(yīng)效果圖片命名規(guī)范為"圖片名+_+on/off"。
例如：menu1_on.gif menu1_off.gif
c. javascript的命名原則
例如：廣告條的javascript文件名為 ad.js 彈出窗口的javascript文件名為 pop.js
d. 動(dòng)態(tài)語言文件命名原則
以性質(zhì)_描述，描述可以有多個(gè)單詞，用“_”隔開，性質(zhì)一般是該頁面得概要。
范例：register_form.asp register_post.asp topic_lock.asp
2.2 文件存放位置規(guī)范
|
_Root |
|
|
|
|
cn |
存放中文HTML文件 |
|
|
en |
存放英文HTML文件 |
|
|
flash |
存放Flash文件 |
|
|
images |
存放圖片文件 |
|
|
imagestudio |
存放PSD源文件 |
|
|
flashstudio |
存放flash源文件 |
|
|
inc |
存放include文件 |
|
|
library |
存放DW庫文件 |
|
|
media |
存放多媒體文件 |
|
|
project |
存放工程項(xiàng)目資料 |
|
|
temp |
存放客戶原始資料 |
|
|
js |
存放JavaScript腳本 |
|
|
css |
存放CSS文件 |
2.3 CSS 書寫規(guī)范
基本原則：
CSS樣式可細(xì)分為3類：自定義樣式、重新定義HTML樣式、鏈接狀態(tài)樣式。
1. 樣式為設(shè)計(jì)師自定義的新 CSS 樣式，影響被使用本樣式的區(qū)域，用于完成網(wǎng)頁中局部的樣式設(shè)定。樣式名 “.”+“相應(yīng)樣式效果描述的單詞或縮寫”例：“ .shadow ”
文字樣式樣式名“.no”+“字號(hào)”+“行距”+“顏色縮寫”例：“ .no12 ” 、“ .no12-24 ”
2. 義HTML樣式為設(shè)計(jì)師重新定義已有的HTML標(biāo)簽樣式，影響全部的被設(shè)定標(biāo)簽樣式，用于統(tǒng)一網(wǎng)頁中某一標(biāo)簽的樣式定義。樣式名“HTML標(biāo)簽”例：hr { border: 1px dotted #333333 }
3. 態(tài)樣式為設(shè)計(jì)師對(duì)鏈接不同狀態(tài)設(shè)定特殊樣式，影響被使用本樣式區(qū)域中的鏈接。
該樣式寫法有2種： a.nav:link nav.a:link 第一種只能修飾標(biāo)簽中；第二種可以修飾所有包含有標(biāo)簽的其他標(biāo)簽。
頁面內(nèi)的樣式加載必須用鏈接方式
注意細(xì)則：
1. 協(xié)作開發(fā)及分工: i會(huì)根據(jù)各個(gè)模塊, 同時(shí)根據(jù)頁面相似程序, 事先寫好大體框架文件, 分配給前端人員實(shí)現(xiàn)內(nèi)部結(jié)構(gòu)&表現(xiàn)&行為; 共用css文件base.css由i書寫, 協(xié)作開發(fā)過程中, 每個(gè)頁面請(qǐng)務(wù)必都要引入, 此文件包含reset及頭部底部樣式, 此文件不可隨意修改;
2. class與id的使用: id是唯一的并是父級(jí)的, class是可以重復(fù)的并是子級(jí)的, 所以id僅使用在大的模塊上, class可用在重復(fù)使用率高及子級(jí)中; id原則上都是由我分發(fā)框架文件時(shí)命名的, 為JavaScript預(yù)留鉤子的除外;
3. 為JavaScript預(yù)留鉤子的命名, 請(qǐng)以 js_ 起始, 比如: js_hide, js_show;
4. class與id命名: 大的框架命名比如header/footer/wrapper/left/right之類的在2中由i統(tǒng)一命名.其他樣式名稱由 小寫英文 & 數(shù)字 & _ 來組合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 盡量使用簡(jiǎn)易的單詞組合; 總之, 命名要語義化, 簡(jiǎn)明化.
5. 規(guī)避class與id命名(此條重要, 若有不明白請(qǐng)及時(shí)與i溝通):
a, 通過從屬寫法規(guī)避, 示例見d;
b, 取父級(jí)元素id/class命名部分命名, 示例見d;
c, 重復(fù)使用率高的命名, 請(qǐng)以自己代號(hào)加下劃線起始, 比如i_clear;
d, a,b兩條, 適用于在2中已建好框架的頁面, 如, 要在2中已建好框架的頁面代碼
中加入新的div元素,按a命名法則:
,樣式寫法: #mainnav .firstnav{.......}
按b命名法則:
,6. css屬性書寫順序, 建議遵循 布局定位屬性-->自身屬性-->文本屬性-->其他屬性. 此條可根據(jù)自身習(xí)慣書寫, 但盡量保證同類屬性寫在一起. 屬性列舉: 布局定位屬性主要包括: margin、padding、float（包括clear）、position（相應(yīng)的 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等.我所列出的這些屬性只是最常用到的, 并不代表全部;
7. 書寫代碼前, 考慮并提高樣式重復(fù)使用率;
8. 充分利用html自身屬性及樣式繼承原理減少代碼量, 比如:
定義ul.list li{position:relative} ul.list li span{position:absolute; right:0}
即可實(shí)現(xiàn)日期居右顯示
9. 樣式表中中文字體名, 請(qǐng)務(wù)必轉(zhuǎn)碼成unicode碼, 以避免編碼錯(cuò)誤時(shí)亂碼;
10. 背景圖片請(qǐng)盡可能使用sprite技術(shù), 減小http請(qǐng)求, 考慮到多人協(xié)作開發(fā), sprite按模塊制作;
11. 使用table標(biāo)簽時(shí)(盡量避免使用table標(biāo)簽), 請(qǐng)不要用width/ height/cellspacing/cellpadding等table屬性直接定義表現(xiàn), 應(yīng)盡可能的利用table自身私有屬性分離結(jié)構(gòu)與表現(xiàn), 如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文件中我會(huì)初始化表格樣式)
12. 杜絕使用 兼容ie8;
13. 用png圖片做圖片時(shí), 要求圖片格式為png-8格式,若png-8實(shí)在影響圖片質(zhì)量或其中有半透明效果, 請(qǐng)為ie6多帶帶定義背景:
background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);
14. 避免兼容性屬性的使用, 比如text-shadow || css3的相關(guān)屬性;
15. 減少使用影響性能的屬性, 比如position:absolute || float ;
16. 必須為大區(qū)塊樣式添加注釋, 小區(qū)塊適量注釋;
17. 代碼縮進(jìn)與格式: 建議單行書寫, 可根據(jù)自身習(xí)慣, 后期優(yōu)化i會(huì)統(tǒng)一處理;
命名規(guī)則：
頭：header
內(nèi)容：content/container
尾：footer
導(dǎo)航：nav
側(cè)欄：sidebar
欄目：column
頁面外圍控制整體布局寬度：wrapper
左右中：left right center
登錄條：loginbar
標(biāo)志：logo
廣告：banner
頁面主體：main
熱點(diǎn)：hot
新聞：news
下載：download
子導(dǎo)航：subnav
菜單：menu
子菜單：submenu
搜索：search
友情鏈接：friendlink
頁腳：footer
版權(quán)：copyright
滾動(dòng)：scroll
內(nèi)容：content
標(biāo)簽頁：tab
文章列表：list
提示信息：msg
小技巧：tips
欄目標(biāo)題：title
加入：joinus
指南：guild
服務(wù)：service
注冊(cè)：regsiter
狀態(tài)：status
投票：vote
合作伙伴：partner
(二)注釋的寫法:
/* Footer */
內(nèi)容區(qū)
/* End Footer */
(三)id的命名:
(1)頁面結(jié)構(gòu)
容器: container
頁頭：header
內(nèi)容：content/container
頁面主體：main
頁尾：footer
導(dǎo)航：nav
側(cè)欄：sidebar
欄目：column
頁面外圍控制整體布局寬度：wrapper
左右中：left right center
(2)導(dǎo)航
導(dǎo)航：nav
主導(dǎo)航：mainbav
子導(dǎo)航：subnav
頂導(dǎo)航：topnav
邊導(dǎo)航：sidebar
左導(dǎo)航：leftsidebar
右導(dǎo)航：rightsidebar
菜單：menu
子菜單：submenu
標(biāo)題: title
摘要: summary
(3)功能
標(biāo)志：logo
廣告：banner
登陸：login
登錄條：loginbar
注冊(cè)：regsiter
搜索：search
功能區(qū)：shop
標(biāo)題：title
加入：joinus
狀態(tài)：status
按鈕：btn
滾動(dòng)：scroll
標(biāo)簽頁：tab
文章列表：list
提示信息：msg
當(dāng)前的: current
小技巧：tips
圖標(biāo): icon
注釋：note
指南：guild
服務(wù)：service
熱點(diǎn)：hot
新聞：news
下載：download
投票：vote
合作伙伴：partner
友情鏈接：link
版權(quán)：copyright
基本樣式：
/* CSS Document */
body {margin:0; padding:0; font:12px "5B8B4F53",san-serif;background:#fff;}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,blockquote,p{padding:0; margin:0;}
table,td,tr,th{font-size:12px;}
li{list-style-type:none;}
img{vertical-align:top;border:0;}
ol,ul {list-style:none;}
h1,h2,h3,h4,h5,h6 {font-size:12px; font-weight:normal;}
address,cite,code,em,th {font-weight:normal; font-style:normal;}
.fB{font-weight:bold;}
.f12px{font-size:12px;}
.f14px{font-size:14px;}
.left{float:left;}
.right{float:right;}
a {color:#2b2b2b; text-decoration:none;}
a:visited {text-decoration:none;}
a:hover {color:#ba2636;text-decoration:underline;}
a:active {color:#ba2636;}
重定義的最先，偽類其次，自定義最后，便于自己和他人閱讀！
不同瀏覽器上字號(hào)保持一致，字號(hào)建議用點(diǎn)數(shù)pt和像素px來定義，pt一般使用中文宋體的9pt 和11pt，px一般使用中文宋體12px 和14.7px 這是經(jīng)過優(yōu)化的字號(hào)，黑體字或者宋體字加粗時(shí)，一般選用11pt 和14.7px 的字號(hào)比較合適。中英文混排時(shí)，我們盡可能的將英文和數(shù)字定義為verdana 和arial 兩種字體。
2.4 html 書寫規(guī)范
head區(qū)是指HTML代碼的
和之間的內(nèi)容。必須加入的標(biāo)簽
a) 公司版權(quán)注釋
b) 網(wǎng)頁顯示字符集
簡(jiǎn)體中文：
繁體中文�
英 語：
c) 網(wǎng)頁制作者信息
d) 網(wǎng)站簡(jiǎn)介
e) 搜索關(guān)鍵字
f) 網(wǎng)頁的css規(guī)范
g) 網(wǎng)頁標(biāo)題
可以選擇加入的標(biāo)簽
a) 設(shè)定網(wǎng)頁的到期時(shí)間。一旦網(wǎng)頁過期，必須到服務(wù)器上重新調(diào)閱。
b) 禁止瀏覽器從本地機(jī)的緩存中調(diào)閱頁面內(nèi)容。
c) 用來防止別人在框架里調(diào)用你的頁面。
d) 自動(dòng)跳轉(zhuǎn)。
5指時(shí)間停留5秒
e) 網(wǎng)頁搜索機(jī)器人向?qū)?。用來告訴搜索機(jī)器人哪些頁面需要索引，哪些頁面不需要索引。
CONTENT的參數(shù)有all,none,index,noindex,follow,nofollow。默認(rèn)是all。
f) 收藏夾圖標(biāo)
g) 所有的javascript的調(diào)用盡量采取外部調(diào)用.
h) 附
標(biāo)簽： 標(biāo)簽不屬于head區(qū)，這里強(qiáng)調(diào)一下，為了保證瀏覽器的兼容性，必須設(shè)置頁面背景
標(biāo)記，注意，一般情況下，請(qǐng)不要省略
結(jié)束標(biāo)記 。
| 縮進(jìn)兩個(gè)半角空格， | 中如果還有嵌套的表格，
|
