編碼規(guī)范 (一)HTML

前言

統(tǒng)一的編碼規(guī)范,有助于編寫(xiě)高質(zhì)量、穩(wěn)定遮糖、可維護(hù)的代碼。

本文引自:編碼規(guī)范 by @mdo

黃金定律
不管有多少人共同參與同一項(xiàng)目叠赐,一定要確保每一行代碼都像是同一個(gè)人編寫(xiě)的欲账。

實(shí)用為王
盡量遵循 HTML 標(biāo)準(zhǔn)和語(yǔ)義屡江,但是不要以犧牲實(shí)用性為代價(jià)。任何時(shí)候都要盡量使用最少的標(biāo)簽并保持最小的復(fù)雜度赛不。

一惩嘉、語(yǔ)法

  • 使用兩個(gè)空格來(lái)代替制表符
  • 嵌套元素應(yīng)當(dāng)縮進(jìn)一次(即兩個(gè)空格)
  • 對(duì)于屬性的定義,確保全部使用雙引號(hào)踢故,絕不要使用單引號(hào)文黎。
  • 不要在自閉合元素的尾部添加斜線
  • 不要省略可選的結(jié)束標(biāo)簽

二、HTML5 doctype

為每個(gè) HTML 頁(yè)面的第一行添加標(biāo)準(zhǔn)模式的聲明殿较,這樣能夠確保在每個(gè)瀏覽器中擁有一致的展現(xiàn)耸峭。

<!DOCTYPE html>
<html>
  <head>
  </head>
</html>

三、語(yǔ)言屬性

強(qiáng)烈建議為 html 根元素指定 lang 屬性淋纲,從而為文檔設(shè)置正確的語(yǔ)言劳闹。這將有助于語(yǔ)音合成工具確定其所應(yīng)該采用的發(fā)音,有助于翻譯工具確定其翻譯時(shí)所應(yīng)遵守的規(guī)則等等洽瞬。

<html lang="en-us">

</html>

四本涕、IE 兼容模式

IE 支持通過(guò)特定的 <meta> 標(biāo)簽來(lái)確定繪制當(dāng)前頁(yè)面所應(yīng)該采用的 IE 版本。除非有強(qiáng)烈的特殊需求片任,否則最好是設(shè)置為 edge mode偏友,從而通知 IE 采用其所支持的最新的模式。

<meta http-equiv="X-UA-Compatible" content="IE=Edge">

五对供、字符編碼

通過(guò)明確聲明字符編碼位他,能夠確保瀏覽器快速并容易的判斷頁(yè)面內(nèi)容的渲染方式。這樣做的好處是产场,可以避免在 HTML 中使用字符實(shí)體標(biāo)記鹅髓,從而全部與文檔編碼一致(一般采用 UTF-8 編碼)。

  <meta charset="UTF-8">

六京景、引入 CSS 和 JavaScript 文件

根據(jù) HTML5 規(guī)范窿冯,在引入 CSS 和 JavaScript 文件時(shí)一般不需要指定 type 屬性,因?yàn)?text/csstext/javascript 分別是它們的默認(rèn)值确徙。

<!-- link -->
<link rel="stylesheet" href="code-guide.css">

<!-- style -->
<style></style>

<!-- script -->
<script src="code-guide.js"></script>

七醒串、屬性順序

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

  • class
  • id, name
  • data-*
  • src, for, type, href, value
  • title, alt
  • role, aria-*

class 用于標(biāo)識(shí)高度可復(fù)用組件芜赌,因此應(yīng)該排在首位。id 用于標(biāo)識(shí)具體組件伴逸,應(yīng)當(dāng)謹(jǐn)慎使用缠沈,因此排在第二位。

<a class="..." id="..." data-toggle="modal" href="#"></a>

<input class="form-control" type="text">

![](...)

八、布爾型屬性

布爾型屬性可以在聲明時(shí)不賦值洲愤,直接寫(xiě)屬性名認(rèn)為是 true颓芭,不寫(xiě)認(rèn)為是 false

<input type="text" disabled required>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>

九柬赐、減少標(biāo)簽的數(shù)量

編寫(xiě) HTML 代碼時(shí)亡问,盡量避免多余的父元素。很多時(shí)候肛宋,這需要迭代和重構(gòu)來(lái)實(shí)現(xiàn)玛界。

<!-- 一般 -->
<span class="avatar">
  ![](...)
</span>

<!-- 更好 -->
![](...)

十、盡量避免使用 JavaScript 生成的標(biāo)簽

通過(guò) JavaScript 生成的標(biāo)簽讓內(nèi)容變得不易查找悼吱、編輯,對(duì)搜索引擎不友好良狈,并且降低性能后添。能避免時(shí)盡量避免。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末薪丁,一起剝皮案震驚了整個(gè)濱河市遇西,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌严嗜,老刑警劉巖粱檀,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異漫玄,居然都是意外死亡茄蚯,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)睦优,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)渗常,“玉大人,你說(shuō)我怎么就攤上這事汗盘≈宓猓” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵隐孽,是天一觀的道長(zhǎng)癌椿。 經(jīng)常有香客問(wèn)我,道長(zhǎng)菱阵,這世上最難降的妖魔是什么踢俄? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮送粱,結(jié)果婚禮上褪贵,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好脆丁,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布世舰。 她就那樣靜靜地躺著,像睡著了一般槽卫。 火紅的嫁衣襯著肌膚如雪跟压。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,562評(píng)論 1 305
  • 那天歼培,我揣著相機(jī)與錄音震蒋,去河邊找鬼。 笑死躲庄,一個(gè)胖子當(dāng)著我的面吹牛查剖,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播噪窘,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼笋庄,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了倔监?” 一聲冷哼從身側(cè)響起直砂,我...
    開(kāi)封第一講書(shū)人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎浩习,沒(méi)想到半個(gè)月后静暂,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡谱秽,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年洽蛀,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片弯院。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡辱士,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出听绳,到底是詐尸還是另有隱情颂碘,我是刑警寧澤,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布椅挣,位于F島的核電站头岔,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏鼠证。R本人自食惡果不足惜峡竣,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望量九。 院中可真熱鬧适掰,春花似錦颂碧、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至费就,卻和暖如春诉瓦,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背力细。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工睬澡, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人眠蚂。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓煞聪,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親逝慧。 傳聞我的和親對(duì)象是個(gè)殘疾皇子米绕,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

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