黃金定律

永遠遵循同一套編碼規(guī)范,不管有多少人共同參與同一項目,一定要確保每一行代碼都像是同一個人編寫的.

一、語法:

1.用兩個空格來代替制表符(tab);

2.嵌套元素應當縮進一次(兩個空格);　　

3.對于屬性的定義,確保全部使用雙引號,絕不要使用單引號;　　

4.不要在自閉合元素的尾部添加斜線--HTML5規(guī)范(https://dev.w3.org/html5/spec-author-view/syntax.html#syntax-start-tag)中明確說明這是可選的;　

5.不要省略可選的結(jié)束標簽;

6.為每個HTML頁面的第一行添加標準模式的聲明,這樣能確保在每個瀏覽器中有一只的展現(xiàn);

二、語言屬性:

根據(jù)HTML5規(guī)范,建議為HTML根元素指定 lang 屬性,從而為文本設置正確的語言.這將有助于語音合成工具確定其應該采用的發(fā)音,有助于翻譯工具確定翻譯時應遵守的規(guī)則等等.lang 屬性列表:http://www.sitepoint.com/web-foundations/iso-2-letter-language-codes/

三、IE兼容模式:　　

IE支持通過特定的標簽來確定回執(zhí)當前頁面所應該采用的IE版本.除非有強烈要求,否則最好是設置為edge mode,從而統(tǒng)治IE采用其所支持的最新的模式.

四、字符編碼:

通過聲明字符編碼,能夠確保瀏覽器快速并容易的判斷頁面內(nèi)容的渲染方式.這樣做可以避免在HTML中使用字符實體標記,從而全部與文檔編碼一致.

五、引入css和JavaScript文件:

根據(jù)HTML5規(guī)范,再引入css和JavaScript文件時一般不需要指定type屬性,因為text/css和text/javascript分別是他們的默認值.

六、實用為王:　

盡量遵循HTML標準和語義,但是不要以犧牲實用性為代價.任何時候都要盡量使用最少的標簽并保持最小的復雜度.

七、屬性順序:

HTML屬性應當按照以下順序依次排列,確保代碼的易讀性:

1.class

2.id,name　　　　

3.data-*　　　　

4.src,for,type,href　　　　

5.title,alt　　　　

6.Aria,role　　

class用于標示高度可復用的組件,因此應該排在首位.

八、減少標簽的數(shù)量

編寫HTML代碼時,盡量避免多余的父元素.很多時候,這需要迭代和重構(gòu)來實現(xiàn).

九、JavaScript生成的標簽

通過JavaScript生成的標簽讓內(nèi)容變得不易查找、編輯,并且境地性能.能避免是盡量避免.

十、CSS語法:

1.用兩個空格來代替制表符(tab);　　

2.為選擇器分組時,將單獨的選擇器單獨放在一行;　　

3.為了代碼的易讀性,在每個聲明塊的左花括號錢添加一個空格;　　

4.聲明塊的右花括號應該單獨成行;　　

5.每條聲明語句的 : 后面應該插入一個空格;　　

6.為了獲得更準確的錯誤報告,每條聲明都應該獨占一行;　　

7.所有聲明語句都應該以分號結(jié)尾,最后一條聲明語句后面的分號是可選的,但是如果省略這個分號,代碼可能更容易出;　　

8.對于以逗號分隔的屬性值,每個逗號后面都應該插入一個空格;　　

9.對于屬性值或顏色參數(shù),省略小于1的小數(shù)前面的0(例如 .5代替0.5);　　

10.十六進制值應該全部小寫,例如:#fff,盡量使用簡寫形式的十六進制值,例如用#fff代替#ffffff;　　

11.為選擇其中的屬性添加雙引號,例如 input[type="text"];　　

12.避免為 0 值指定單位,例如用margin:0 代替margin:0px.

十一、聲明順序:

相關的屬性聲明應該歸為一組,并且按照下面的順序排列:　　　

1.positioning(position: absolute; top: 0; bottom: 0; right: 0; left: 0; z-index: 100;);　　　

2.box model(display: block; float: left; width: 100px; height: 100px;);　　　

3.typographic(font: normal 13px "Microsoft YaHei"; line-height: 1.5em; color: #333; text-align:center;);　　　

4.visual(background: yellow; border: 1px solid #c00; border-radius: 3px; opacity: 1; );

由于定位(positioning)可以從正常的文檔流中移除元素,并且還能覆蓋盒模型(box model)相關的樣式,因此排在首位.盒模型排在第二位,因為他決定了組建的尺寸和位置.其他屬性知識影響組建的內(nèi)部(inside)或者是不影響前兩組屬性,因此排在后面.

十二、不要使用@import　　

與標簽相比,@import指令要慢很多,不光增加了額外的請求次數(shù),還會導致不可預料的問題.替代辦法有一下幾種:

1.使用多個元素;　　　　　

2.通過sass或less類似的css預處理器將多個css文件便以為一個文件;　　　　　

3.通過rails、jekyll或者其他系統(tǒng)中提供過css文件合并功能.

十三、媒體查詢(media query)的位置

將媒體查詢盡可能放在相關規(guī)則的附近.不要將他們打包放在一個單一樣式文件中或者放在文檔底部.

十四、帶前綴的屬性:　

當使用特定廠商的帶前綴的屬性時,通過鎖緊的方式,讓每個屬性的值在垂直方向?qū)R,這樣方便多行編輯.例如:　　　　

CSS Code

1..selector { 　　　　   

2.  

3.　　　　　　　　-webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15); 　　　　　　　　   

4.  

5.　　　　　　　　　　　　box-shadow: 0 1px 2px rgba(0,0,0,.15); 　　　　   

6.  

7.}   

8.  

十五、單行規(guī)則聲明:

　　對于值包含一條聲明的樣式,為了易讀性和便于快速編輯,建議將語句放在同一行.對于帶有多條聲明的樣式,還是應當將聲明分為多行.這樣做的關鍵因素是為了錯誤檢測.例如css校驗器之處在180行有語法錯誤,如果是單行單條聲明,你就不會忽略這個錯誤,如果是單行多條聲明的話,你就要仔細分析避免漏掉錯誤了.

十六、Less和Sass中的嵌套

　避免非必要的嵌套.這是因為雖然你可以使用嵌套,但是并不意味著應該使用嵌套.只有在必須將樣式限制在父元素內(nèi)(也就是后代選擇器),并且存在多個需要嵌套的元素師才能使用嵌套.

十七、注釋:

代碼是由人編寫并維護的.請確保你的代碼能夠自描述、注釋良好并且易于他人理解.好的代碼注釋能夠傳遞上下文關系和代碼目的;

不要簡單地重申組件或者class名稱;

對于較長的注釋,務必書寫完整的句子,對于一般性的注釋,可以書寫簡介的短語.

十八、class命名

class名稱中只能出現(xiàn)謝小字符和破折號(不是下劃線也不是駝峰命名法).破折號應當用于相關class的命名(類似命名空間,例如.btn和.btn-danger)

避免過度任意的簡寫. .btn代表button,但是.s不能表達任何意思;　　

class名應該盡可能短,并且意義明確;　　

使用有意義的名稱,使用有組織的或者目的明確的名稱,不要使用表現(xiàn)形式的名稱;　　

基于最近的class或者基本class作為新class的前綴;　　

使用.js-* class來標識行為(與樣式相對),并且不要將這些class包含到css文件中;　　

在為sass和less變量命名時也可以參考上面列出的各項規(guī)范.

十九、選擇器

對于通用元素使用class,這樣利于渲染性能的優(yōu)化;　　

對于經(jīng)常出現(xiàn)的組件,避免使用屬性選擇器(例如:[class^="···"]),瀏覽器的性能會受到這些因素的影響;　　

選擇器盡可能短,并且盡量限制組成選擇器的元素個數(shù),建議不要超過3個;　　

只有在必要的時候才將class限制在最近的父元素內(nèi).

二十、代碼組織:

以組建為單位組織代碼段;　　

指定一致的注釋規(guī)范;　　

使用一致的空白符將代碼分隔成塊,這樣利于掃描較大的文檔;　　

如果使用了多個css文件,將其按照組件而不是頁面的形式拆分,因為頁面會被重組,而組件只會被移動.

以上就是本文的全部內(nèi)容，希望對大家編寫規(guī)范、靈活、穩(wěn)定、高質(zhì)量的HTML和css代碼有所幫助。