HTML 和 CSS 代碼的規(guī)范

HTML :

<br />

一.語法:

- 用兩個空格來代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法忧换。
- 嵌套元素應(yīng)當(dāng)縮進(jìn)一次(即兩個空格)尤泽。
- 對于屬性的定義楞件,確保全部使用雙引號生闲,絕不要使用單引號诀诊。
- 不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規(guī)范中明確說明這是可選的诽嘉。
- 不要省略可選的結(jié)束標(biāo)簽(closing tag)(例如菌湃,<code>< /li ></code> 或 <code>< /body ></code>)听皿。
<!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    ![](images/jesusLovesYou.png)
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>

<br />

二.HTML5 doctype

為每個 HTML 頁面的第一行添加標(biāo)準(zhǔn)模式(standard mode)的聲明回挽,這樣能夠確保在每個瀏覽器中擁有一致的展現(xiàn)阱高。
<!DOCTYPE html>
<html>
  <head>
  </head>
</html>

<br />

三.語言屬性

根據(jù) HTML5 規(guī)范:強(qiáng)烈建議為 html 根元素指定 lang 屬性泪酱,從而為文檔設(shè)置正確的語言蝎困。這將有助于語音合成工具確定其所應(yīng)該采用的發(fā)音护昧,有助于翻譯工具確定其翻譯時所應(yīng)遵守的規(guī)則等等莫其。

點(diǎn)擊前往語言代碼表

<html lang="en-us">
  <!-- ... -->
</html>

<br />

四.IE 兼容模式

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

閱讀這篇 stack overflow 上的文章可以獲得更多有用的信息。

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

<br />

五.字符編碼

通過明確聲明字符編碼憨颠,能夠確保瀏覽器快速并容易的判斷頁面內(nèi)容的渲染方式胳徽。這樣做的好處是,可以避免在 HTML 中使用字符實(shí)體標(biāo)記(character entity)爽彤,從而全部與文檔編碼一致(一般采用 UTF-8 編碼)养盗。
<head>
  <meta charset="UTF-8">
</head>

<br />

六.引入 CSS 和 JavaScript 文件

根據(jù) HTML5 規(guī)范,在引入 CSS 和 JavaScript 文件時一般不需要指定<code> type </code> 屬性适篙,因?yàn)?lt;code> text/css </code> 和<code> text/javascript </code>分別是它們的默認(rèn)值往核。
<!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">

<!-- In-document CSS -->
<style>
  /* ... */
</style>

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

<br />

實(shí)用為王 :

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

<br />

一.屬性順序

HTML 屬性應(yīng)當(dāng)按照以下給出的順序依次排列,確保代碼的易讀性丹喻。
  • class
  • id, name
  • data-*
  • src, for, type, href, value
  • title, alt
  • role, aria-*

<code>class</code> 用于標(biāo)識高度可復(fù)用組件薄货,因此應(yīng)該排在首位。<code>id</code> 用于標(biāo)識具體組件碍论,應(yīng)當(dāng)謹(jǐn)慎使用(例如谅猾,頁面內(nèi)的書簽),因此排在第二位鳍悠。

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

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

![](...)

<br />

二.布爾(boolean)型屬性

布爾型屬性可以在聲明時不賦值税娜。XHTML 規(guī)范要求為其賦值,但是 HTML5 規(guī)范不需要藏研。
元素的布爾型屬性如果有值敬矩,就是 true,如果沒有值蠢挡,就是 false弧岳。
如果屬性存在凳忙,其值必須是空字符串或 [...] 屬性的規(guī)范名稱,并且不要在首尾添加空白符禽炬。
簡單來說涧卵,就是不用賦值。
<input type="text" disabled>

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

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

<br />

三.減少標(biāo)簽的數(shù)量

編寫 HTML 代碼時腹尖,盡量避免多余的父元素柳恐。很多時候,這需要迭代和重構(gòu)來實(shí)現(xiàn)热幔。請看下面的案例:
<!-- 不太好 -->
<span class="avatar">
  ![](...)
</span>

<!-- 推薦! -->
![](...)

<br />

四.JavaScript 生成的標(biāo)簽

通過 JavaScript 生成的標(biāo)簽讓內(nèi)容變得不易查找乐设、編輯,并且降低性能断凶。能避免時盡量避免伤提。

<br />
CSS
==
<br />

一.語法

- 用兩個空格來代替制表符(tab) -- 這是唯一能保證在所有環(huán)境下獲得一致展現(xiàn)的方法。
- 為選擇器分組時认烁,將單獨(dú)的選擇器單獨(dú)放在一行。
- 為了代碼的易讀性介汹,在每個聲明塊的左花括號前添加一個空格却嗡。
- 聲明塊的右花括號應(yīng)當(dāng)單獨(dú)成行。
- 每條聲明語句的 : 后應(yīng)該插入一個空格嘹承。
- 為了獲得更準(zhǔn)確的錯誤報告窗价,每條聲明都應(yīng)該獨(dú)占一行。
- 所有聲明語句都應(yīng)當(dāng)以分號結(jié)尾叹卷。最后一條聲明語句后面的分號是可選的撼港,但是,如果省略這個分號骤竹,你的代碼可能更易出錯帝牡。
- 對于以逗號分隔的屬性值,每個逗號后面都應(yīng)該插入一個空格(例如蒙揣,box-shadow)靶溜。
- 不要在 rgb()、rgba()懒震、hsl()罩息、hsla() 或 rect() 值的內(nèi)部的逗號后面插入空格。這樣利于從多個屬性值(既加逗號也加空格)中區(qū)分多個顏色值(只加逗號个扰,不加空格)瓷炮。
- 對于屬性值或顏色參數(shù),省略小于 1 的小數(shù)前面的 0 (例如递宅,.5 代替 0.5娘香;-.5px 代替 -0.5px)苍狰。
- 十六進(jìn)制值應(yīng)該全部小寫,例如茅主,#fff舞痰。在掃描文檔時,小寫字符易于分辨诀姚,因?yàn)樗麄兊男问礁子趨^(qū)分响牛。
- 盡量使用簡寫形式的十六進(jìn)制值,例如赫段,用 #fff 代替 #ffffff呀打。
- 為選擇器中的屬性添加雙引號,例如糯笙,input[type="text"]贬丛。只有在某些情況下是可選的,但是给涕,為了代碼的一致性豺憔,建議都加上雙引號。
- 避免為 0 值指定單位够庙,例如恭应,用 margin: 0; 代替 margin: 0px;。
/* Bad CSS */
.selector, .selector-secondary, .selector[type=text] {
  padding:15px;
  margin:0px 0px 15px;
  background-color:rgba(0, 0, 0, 0.5);
  box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF
}

/* Good CSS */
.selector,
.selector-secondary,
.selector[type="text"] {
  padding: 15px;
  margin-bottom: 15px;
  background-color: rgba(0,0,0,.5);
  box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff;
}

<br />

二.聲明順序

相關(guān)的屬性聲明應(yīng)當(dāng)歸為一組耘眨,并按照下面的順序排列:
  • Positioning
  • Box model
  • Typographic
  • Visual
由于定位(positioning)可以從正常的文檔流中移除元素昼榛,并且還能覆蓋盒模型(box model)相關(guān)的樣式,因此排在首位剔难。盒模型排在第二位胆屿,因?yàn)樗鼪Q定了組件的尺寸和位置。
其他屬性只是影響組件的內(nèi)部(inside)或者是不影響前兩組屬性偶宫,因此排在后面非迹。
.declaration-order {
  /* Positioning */
  position: absolute;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  z-index: 100;

  /* Box-model */
  display: block;
  float: right;
  width: 100px;
  height: 100px;

  /* Typography */
  font: normal 13px "Helvetica Neue", sans-serif;
  line-height: 1.5;
  color: #333;
  text-align: center;

  /* Visual */
  background-color: #f5f5f5;
  border: 1px solid #e5e5e5;
  border-radius: 3px;

  /* Misc */
  opacity: 1;
}

<br />

三.不要使用 @import

與 <link> 標(biāo)簽相比,@import 指令要慢很多读宙,不光增加了額外的請求次數(shù)彻秆,還會導(dǎo)致不可預(yù)料的問題。替代辦法有以下幾種:
使用多個 <link> 元素
通過 Sass 或 Less 類似的 CSS 預(yù)處理器將多個 CSS 文件編譯為一個文件
通過 Rails结闸、Jekyll 或其他系統(tǒng)中提供過 CSS 文件合并功能
<!-- Use link elements -->
<link rel="stylesheet" href="core.css">

<!-- Avoid @imports -->
<style>
  @import url("more.css");
</style>

<br />

四.媒體查詢(Media query)的位置

將媒體查詢放在盡可能相關(guān)規(guī)則的附近唇兑。不要將他們打包放在一個單一樣式文件中或者放在文檔底部。如果你把他們分開了桦锄,將來只會被大家遺忘扎附。下面給出一個典型的實(shí)例。
.element { ... }
.element-avatar { ... }
.element-selected { ... }

@media (min-width: 480px) {
  .element { ...}
  .element-avatar { ... }
  .element-selected { ... }
}

<br />

五.帶前綴的屬性

當(dāng)使用特定廠商的帶有前綴的屬性時结耀,通過縮進(jìn)的方式留夜,讓每個屬性的值在垂直方向?qū)R匙铡,這樣便于多行編輯。
在 Textmate 中碍粥,使用 Text → Edit Each Line in Selection (??A)鳖眼。在 Sublime Text 2 中,使用 Selection → Add Previous Line (??↑) 和 Selection → Add Next Line (??↓)嚼摩。
/* Prefixed properties */
.selector {
  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
          box-shadow: 0 1px 2px rgba(0,0,0,.15);
}

<br />

六.單行規(guī)則聲明

對于只包含一條聲明的樣式钦讳,為了易讀性和便于快速編輯,建議將語句放在同一行枕面。對于帶有多條聲明的樣式愿卒,還是應(yīng)當(dāng)將聲明分為多行。
這樣做的關(guān)鍵因素是為了錯誤檢測 -- 例如潮秘,CSS 校驗(yàn)器指出在 183 行有語法錯誤琼开。如果是單行單條聲明,你就不會忽略這個錯誤枕荞;如果是單行多條聲明的話柜候,你就要仔細(xì)分析避免漏掉錯誤了。
/* Single declarations on one line */
.span1 { width: 60px; }
.span2 { width: 140px; }
.span3 { width: 220px; }

/* Multiple declarations, one per line */
.sprite {
  display: inline-block;
  width: 16px;
  height: 15px;
  background-image: url(../img/sprite.png);
}
.icon           { background-position: 0 0; }
.icon-home      { background-position: 0 -20px; }
.icon-account   { background-position: 0 -40px; }

<br />

七.簡寫形式的屬性聲明

在需要顯示地設(shè)置所有值的情況下躏精,應(yīng)當(dāng)盡量限制使用簡寫形式的屬性聲明改橘。常見的濫用簡寫屬性聲明的情況如下:
  • padding
  • margin
  • font
  • background
  • border
  • border-radius
大部分情況下,我們不需要為簡寫形式的屬性聲明指定所有值玉控。例如,HTML 的 heading 元素只需要設(shè)置上狮惜、下邊距(margin)的值高诺,因此,在必要的時候碾篡,只需覆蓋這兩個值就可以虱而。過度使用簡寫形式的屬性聲明會導(dǎo)致代碼混亂,并且會對屬性值帶來不必要的覆蓋從而引起意外的副作用开泽。
/* Bad example */
.element {
  margin: 0 0 10px;
  background: red;
  background: url("image.jpg");
  border-radius: 3px 3px 0 0;
}

/* Good example */
.element {
  margin-bottom: 10px;
  background-color: red;
  background-image: url("image.jpg");
  border-top-left-radius: 3px;
  border-top-right-radius: 3px;
}

<br />

八.Less 和 Sass 中的嵌套

避免不必要的嵌套牡拇。這是因?yàn)殡m然你可以使用嵌套,但是并不意味著應(yīng)該使用嵌套穆律。只有在必須將樣式限制在父元素內(nèi)(也就是后代選擇器)惠呼,并且存在多個需要嵌套的元素時才使用嵌套。
// Without nesting
.table > thead > tr > th { … }
.table > thead > tr > td { … }

// With nesting
.table > thead > tr {
  > th { … }
  > td { … }
}

<br />

九.Less 和 Sass 中的操作符

為了提高可讀性峦耘,在圓括號中的數(shù)學(xué)計算表達(dá)式的數(shù)值剔蹋、變量和操作符之間均添加一個空格。
// Bad example
.element {
  margin: 10px 0 @variable*2 10px;
}

// Good example
.element {
  margin: 10px 0 (@variable * 2) 10px;
}

<br />

十.注釋

代碼是由人編寫并維護(hù)的辅髓。請確保你的代碼能夠自描述泣崩、注釋良好并且易于他人理解少梁。好的代碼注釋能夠傳達(dá)上下文關(guān)系和代碼目的。不要簡單地重申組件或 class 名稱矫付。
對于較長的注釋凯沪,務(wù)必書寫完整的句子;對于一般性注解买优,可以書寫簡潔的短語妨马。
/* Bad example */
/* Modal header */
.modal-header {
  ...
}

/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}

<br />

十一.class 命名

  • class 名稱中只能出現(xiàn)小寫字符和破折號(dashe)(不是下劃線,也不是駝峰命名法)而叼。破折號應(yīng)當(dāng)用于相關(guān) class 的命名(類似于命名空間)(例如身笤,.btn 和 .btn-danger)。
  • 避免過度任意的簡寫葵陵。.btn 代表 button液荸,但是 .s 不能表達(dá)任何意思。
  • class 名稱應(yīng)當(dāng)盡可能短脱篙,并且意義明確娇钱。
  • 使用有意義的名稱。使用有組織的或目的明確的名稱绊困,不要使用表現(xiàn)形式(presentational)的名稱文搂。
  • 基于最近的父 class 或基本(base) class 作為新 class 的前綴。
  • 使用 .js-* class 來標(biāo)識行為(與樣式相對)秤朗,并且不要將這些 class 包含到 CSS 文件中煤蹭。
在為 Sass 和 Less 變量命名時也可以參考上面列出的各項規(guī)范。
/* Bad example */
.t { ... }
.red { ... }
.header { ... }

/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }

<br />

十二.選擇器

對于通用元素使用 class 取视,這樣利于渲染性能的優(yōu)化硝皂。
對于經(jīng)常出現(xiàn)的組件,避免使用屬性選擇器(例如作谭,[class^="..."])稽物。瀏覽器的性能會受到這些因素的影響。
選擇器要盡可能短折欠,并且盡量限制組成選擇器的元素個數(shù)贝或,建議不要超過 3 。
只有在必要的時候才將 class 限制在最近的父元素內(nèi)(也就是后代選擇器)(例如锐秦,不使用帶前綴的 class 時 -- 前綴類似于命名空間)咪奖。
/* Bad example */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }

/* Good example */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }

<br />

十三.代碼組織

以組件為單位組織代碼段。
制定一致的注釋規(guī)范农猬。
使用一致的空白符將代碼分隔成塊赡艰,這樣利于掃描較大的文檔。
如果使用了多個 CSS 文件斤葱,將其按照組件而非頁面的形式分拆慷垮,因?yàn)轫撁鏁恢亟M揖闸,而組件只會被移動。
/*
 * Component section heading
 */

.element { ... }


/*
 * Component section heading
 *
 * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
 */

.element { ... }

/* Contextual sub-component or modifer */
.element-heading { ... }

<br />
編輯器配置
==

將你的編輯器按照下面的配置進(jìn)行設(shè)置料身,以避免常見的代碼不一致和差異:
  • 用兩個空格代替制表符(soft-tab 即用空格代表 tab 符)汤纸。
  • 保存文件時,刪除尾部的空白符芹血。
  • 設(shè)置文件編碼為 UTF-8贮泞。
  • 在文件結(jié)尾添加一個空白行。
參照文檔并將這些配置信息添加到項目的 .editorconfig 文件中幔烛。例如:Bootstrap 中的 .editorconfig 實(shí)例啃擦。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市饿悬,隨后出現(xiàn)的幾起案子令蛉,更是在濱河造成了極大的恐慌,老刑警劉巖狡恬,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件珠叔,死亡現(xiàn)場離奇詭異,居然都是意外死亡弟劲,警方通過查閱死者的電腦和手機(jī)祷安,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來兔乞,“玉大人汇鞭,你說我怎么就攤上這事∮棺罚” “怎么了虱咧?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長锚国。 經(jīng)常有香客問我,道長玄坦,這世上最難降的妖魔是什么血筑? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮煎楣,結(jié)果婚禮上豺总,老公的妹妹穿的比我還像新娘。我一直安慰自己择懂,他們只是感情好喻喳,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著困曙,像睡著了一般表伦。 火紅的嫁衣襯著肌膚如雪谦去。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天蹦哼,我揣著相機(jī)與錄音鳄哭,去河邊找鬼。 笑死纲熏,一個胖子當(dāng)著我的面吹牛妆丘,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播局劲,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼勺拣,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了鱼填?” 一聲冷哼從身側(cè)響起药有,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎剔氏,沒想到半個月后塑猖,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡谈跛,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年羊苟,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片感憾。...
    茶點(diǎn)故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡蜡励,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出阻桅,到底是詐尸還是另有隱情凉倚,我是刑警寧澤,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布嫂沉,位于F島的核電站稽寒,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏趟章。R本人自食惡果不足惜杏糙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望蚓土。 院中可真熱鬧宏侍,春花似錦、人聲如沸蜀漆。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至绷耍,卻和暖如春吐限,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背锨天。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工毯盈, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人病袄。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓搂赋,卻偏偏與公主長得像,于是被迫代替她去往敵國和親益缠。 傳聞我的和親對象是個殘疾皇子脑奠,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評論 2 355

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)幅慌,斷路器宋欺,智...
    卡卡羅2017閱讀 134,659評論 18 139
  • 問答題47 /72 常見瀏覽器兼容性問題與解決方案? 參考答案 (1)瀏覽器兼容問題一:不同瀏覽器的標(biāo)簽?zāi)J(rèn)的外補(bǔ)...
    _Yfling閱讀 13,754評論 1 92
  • 本文主要是起筆記的作用胰伍,內(nèi)容來自慕課網(wǎng). 認(rèn)識CSS樣式 CSS全稱為“層疊樣式表 (Cascading Styl...
    0o凍僵的企鵝o0閱讀 2,646評論 0 30
  • 一 看Harry Potter失聲痛哭的時候有兩次齿诞,一次是鄧布利多在高塔上被斯內(nèi)普用“阿瓦達(dá)索命”擊中,霍格沃茨永...
    Melonmelonmelon閱讀 43,569評論 208 1,302
  • 一瞬間骂租,忽然明白一切不過是自己的一廂情愿祷杈,僅此而已。 是時候曬曬陽光渗饮,本該就不該有的執(zhí)念但汞,放下,看看藍(lán)天互站,白云?私蕾,...
    戀上陽光的魚閱讀 220評論 0 1