Web開發(fā)規(guī)范 (一)

via:Github

通用規(guī)范

  • 使用空格代替TAB辩诞,windows和Linux的Tab占位不同齿坷。
  • CSS樣式屬性和 JavaScript代碼后邊添加分號; 透硝,方便斷句,利于壓縮宪肖。
  • 文件內(nèi)容編碼均統(tǒng)一為UTF-8表制。
  • CSS、JAVASCRIPT中的非注釋類中文字符須轉(zhuǎn)換成unicode編碼使用控乾,以避免編碼錯誤時亂碼顯示么介。

文件規(guī)范

  • 文件名用英文單詞,多個單詞用駝峰命名法蜕衡。
  • 一些瀏覽器會將含有這些詞的作為廣告攔截壤短,文件命名、ID慨仿、CLASS等所有命名避免以上詞匯久脯。ad`、`ads`镶骗、`adv`桶现、`banner`、`sponsor`鼎姊、`gg`、`guangg`相赁、`guanggao

HTML書寫規(guī)范

  • 為每個HTML頁面的第一行添加標(biāo)準(zhǔn)模式(standard mode)的聲明相寇,確保在每個瀏覽器中擁有一致的展現(xiàn)。
    <!DOCTYPE html>
  • 文檔類型聲明統(tǒng)一為HTML5聲明類型钮科,編碼統(tǒng)一為UTF-8唤衫。
    <meta charset="UTF-8">
  • <HEAD>中添加信息。
 <meta name="author" content="smile@kang.cool">//作者
 <meta name="description" content="hello">//網(wǎng)頁描述
 <meta name="keywords" 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">//禁止瀏覽器從本地機(jī)的緩存中調(diào)閱頁面內(nèi)容
 <meta http-equiv="Window-target" content="_top">//用來防止別人在框架里調(diào)用你的頁面
 <meta http-equiv="Refresh" content="5;URL=http://kahn1990.com/">//跳轉(zhuǎn)頁面蛆挫,5指時間停留5秒 網(wǎng)頁搜索機(jī)器人向?qū)г叱小S脕砀嬖V搜索機(jī)器人哪些頁面需要索引,哪些頁面不需要索引
 <meta name="robots" content="none">//content的參數(shù)有all,none,index,noindex,follow,nofollow悴侵,默認(rèn)是all
 <link rel="Shortcut Icon" href="favicon.ico">//收藏圖標(biāo)
 <meta http-equiv="Cache-Control" content="no-cache, must-revalidate">//網(wǎng)頁不會被緩存
  • IE支持通過特定<meta>標(biāo)簽來確定繪制當(dāng)前頁面所應(yīng)該采用的IE版本瞧剖。除非有強(qiáng)烈的特殊需求,否則最好是設(shè)置為edge mode ,從而通知IE采用其所支持的最新的模式抓于。
meta http-equiv="X-UA-Compatible" content="IE=Edge">
  • 非特殊情況下CSS樣式文件外鏈至HEAD之間做粤,JAVASCRIPT文件外鏈至頁面底部。引入JAVASCRIPT庫文件捉撮,文件名須包含庫名稱及版本號及是否為壓縮版怕品。引入JAVASCRIPT插件, 文件名格式為庫名稱+.+插件名稱。jQuery.cookie.js

  • HTML屬性應(yīng)當(dāng)按照以下給出的順序依次排列巾遭,來確保代碼的易讀性堵泽。

class
id 、 name
data-*
src恢总、for迎罗、 type、 href
title片仿、alt
aria-*纹安、 role
  • 編碼均遵循XHTML標(biāo)準(zhǔn),標(biāo)簽砂豌、屬性厢岂、屬性命名由小寫英文、數(shù)字和_組成阳距,且所有標(biāo)簽必須閉合塔粒,屬性值必須用雙引號””,避免使用中文拼音盡量簡易并要求語義化筐摘。
CLASS --> nHeadTitle --> CLASS遵循小駝峰命名法(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>
  • 當(dāng)JAVASCRIPT獲取單個元素時卒茬,通常使用document.getElementById來獲取dom元素,document.getElementById兼容所有瀏覽器咖熟,但I(xiàn)E瀏覽器會混淆元素的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)意符馍管。
<    -->    &lt;
>    -->    &gt;
空格  -->     
  • 含有描述性表單元素(INPUT郭赐,TEXTAREA)添加LABEL。
<p>
    <label for="test">測試</label>
    <input type="text" id="test" />
</p>
  • 多用無兼容性問題的HTML內(nèi)置標(biāo)簽确沸,比如SPAN捌锭、EM、STRONG罗捎、OPTGROUP观谦、LABEL等,需要自定義HTML標(biāo)簽屬性時,首先考慮是否存在已有的合適標(biāo)簽可替換宛逗,如果沒有坎匿,可使用須以“data-”為前綴來添加自定義屬性,避免使用其他命名方式。
  • 語義化HTML替蔬。
  • 盡可能減少<DIV>嵌套告私。
  • 書寫鏈接地址時避免重定向。
    //即在URL地址后面加“/”
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末承桥,一起剝皮案震驚了整個濱河市驻粟,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌凶异,老刑警劉巖蜀撑,帶你破解...
    沈念sama閱讀 211,817評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異剩彬,居然都是意外死亡酷麦,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,329評論 3 385
  • 文/潘曉璐 我一進(jìn)店門喉恋,熙熙樓的掌柜王于貴愁眉苦臉地迎上來沃饶,“玉大人,你說我怎么就攤上這事轻黑『簦” “怎么了?”我有些...
    開封第一講書人閱讀 157,354評論 0 348
  • 文/不壞的土叔 我叫張陵氓鄙,是天一觀的道長馆揉。 經(jīng)常有香客問我,道長抖拦,這世上最難降的妖魔是什么升酣? 我笑而不...
    開封第一講書人閱讀 56,498評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮蟋座,結(jié)果婚禮上拗踢,老公的妹妹穿的比我還像新娘。我一直安慰自己向臀,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,600評論 6 386
  • 文/花漫 我一把揭開白布诸狭。 她就那樣靜靜地躺著券膀,像睡著了一般。 火紅的嫁衣襯著肌膚如雪驯遇。 梳的紋絲不亂的頭發(fā)上芹彬,一...
    開封第一講書人閱讀 49,829評論 1 290
  • 那天,我揣著相機(jī)與錄音叉庐,去河邊找鬼舒帮。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的玩郊。 我是一名探鬼主播肢执,決...
    沈念sama閱讀 38,979評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼译红!你這毒婦竟也來了预茄?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,722評論 0 266
  • 序言:老撾萬榮一對情侶失蹤侦厚,失蹤者是張志新(化名)和其女友劉穎耻陕,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體刨沦,經(jīng)...
    沈念sama閱讀 44,189評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡诗宣,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,519評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了想诅。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片召庞。...
    茶點(diǎn)故事閱讀 38,654評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖侧蘸,靈堂內(nèi)的尸體忽然破棺而出裁眯,到底是詐尸還是另有隱情,我是刑警寧澤讳癌,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布穿稳,位于F島的核電站,受9級特大地震影響晌坤,放射性物質(zhì)發(fā)生泄漏逢艘。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,940評論 3 313
  • 文/蒙蒙 一骤菠、第九天 我趴在偏房一處隱蔽的房頂上張望它改。 院中可真熱鬧,春花似錦商乎、人聲如沸央拖。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,762評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽鲜戒。三九已至,卻和暖如春抹凳,著一層夾襖步出監(jiān)牢的瞬間遏餐,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,993評論 1 266
  • 我被黑心中介騙來泰國打工赢底, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留失都,地道東北人柏蘑。 一個月前我還...
    沈念sama閱讀 46,382評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像粹庞,于是被迫代替她去往敵國和親咳焚。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,543評論 2 349

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理信粮,服務(wù)發(fā)現(xiàn)黔攒,斷路器,智...
    卡卡羅2017閱讀 134,633評論 18 139
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock閱讀 3,371評論 2 36
  • Web前端開發(fā)規(guī)范文檔 規(guī)范目的: 使開發(fā)流程更加規(guī)范化强缘。 通用規(guī)范: TAB鍵用兩個空格代替(WINDOWS下T...
    蕎葉閱讀 544評論 0 1
  • #基本功# 《特質(zhì)》 當(dāng)你在聽演講的時候督惰,你最喜歡演講者身上的什么特質(zhì)? 看到今天晚上的這個話題旅掂,演講者的特質(zhì)的時...
    蜜絲姜閱讀 154評論 0 1
  • 十年前赏胚,在洛陽學(xué)茶。 大概也是這個樣子商虐。每天早早起床觉阅,然后穿過車水馬龍的大街,到熱氣騰騰包子鋪吃籠包子秘车,這很重要典勇。...
    孔雀堂茶號閱讀 404評論 0 3