前端制作Html和Css編碼規范總結發布者:本站 時間:2020-05-16 08:05:45
Html和Css編碼規范總結
Html語法:
l 用兩個空格來代替制表符(tab)--這是唯一能保證在所有環境下獲得一致展現的方法;
l 嵌套元素應該縮進一次(即兩個空格);
l 對于屬性的定義,確保完全使用雙引號,絕對不要使用單引號;
l 不要在自閉和(self-closing)元素的尾部添加斜線--Html5規范中明確說明這是可選的;
l 不要省略可選的結束標簽(closing tag)(例如:</li>或</body>)。
示例:
<!DOCTYPE html>
<html>
<head>
<title>Page title</title>
</head>
<body>
<img src="images/company-logo.png" alt="Company">
<h1 class="hello-world">Hello, world!</h1>
</body>
</html>
Html5 doctype:
為每個Html頁面的第一行添加標準模式(standard mode)的聲明,這樣能確保在每個瀏覽器中擁有一致的展現。
示例:
<!DOCTYPE html>
<html>
<head>
</head>
</html>
語言屬性:
根據Html5規范:
強烈建議為Html根元素制定lang屬性,從而為文檔設置正確的語言。這將有助于語音合成工具確定其所應該采用的發音,有助于翻譯工具確定其翻譯時所應遵守的規則等等。
更多關于lang屬性的知識可以從http://www.w3.org/html/wg/drafts/html/master/semantics.html#the-html-element中了解、語言代碼表http://reference.sitepoint.com/html/lang-codes
示例:
<html lang="en-us">
<!-- ... -->
</html>
IE兼容模式:
IE支持通過特定的<meta>標簽來確定繪制當前頁面所應該采用的IE版本。除非有強烈的特殊需求,否則最好是設置為edge mode,從而通知IE采用其所支持的最新的模式。
閱讀這篇stack overflow上的文章(http://stackoverflow.com/questions/6771258/whats-the-difference-if-meta-http-equiv-x-ua-compatible-content-ie-edge-e)可以獲得更多的信息。
示例:
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
字符編碼:
通過明確聲明字符編碼,能夠確保瀏覽器快速并容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在Html中使用字符實體(character entity)標記,從而全部與文檔編碼一致(一般采用UTF-8編碼)。
示例:
<head>
<meta charset="UTF-8">
</head>
引入Css和JavaScript文件:
根據Html5規范,在引入Css和JavaScript文件時一般不需要指定type屬性,因為text/css和text/javascript分別是他們的默認值。
示例:
<!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">
<!-- In-document CSS -->
<style>
/* ... */
</style>
<!-- JavaScript -->
<script src="code-guide.js"></script>
實用為王:
盡量遵循Html標準和語義,但是不要以犧牲實用性為代價。任何時候都要盡量使用最少的標簽并保持最小的復雜度。
屬性順序:
Html屬性應當按照以下給出的順序依次排列,確保代碼的易讀性。
l class
l id , name
l data-*
l src , for , type , href
l title , alt
l aria-* , role
class用于標識高度可復用組件,因此排在首位。Id用于標識具體組件,應當謹慎使用(例如:頁面內的書簽),因此排在第二位。
示例:
<a class="..." id="..." data-modal="toggle" href="#">
Example link
</a>
<input class="form-control" type="text">
<img src="..." alt="...">
布爾(boolean)屬性:
布爾型屬性可以在聲明時不賦值。XHtml規范要求為其賦值,但是Html5規范不需要,更多信息參考WhatWG section on boolean attributes(http://www.whatwg.org/specs/web-apps/current-work/multipage/common-microsyntaxes.html#boolean-attributes)。
元素的布爾型屬性如果有值,就是true,如果沒有值,就是false。
如果一定要為其賦值的話,請參考WhatWG規范:如果屬性存在,其值必須是空字符串或[...]屬性的規范名稱,并且不要在收尾添加空白符,簡單來說,就是不用賦值。
示例:
<input type="text" disabled>
<input type="checkbox" value="1" checked>
<select>
<option value="1" selected>1</option>
</select>
減少標簽的數量:
編寫Html代碼時,盡量避免多余的父元素。很多時候,這需要迭代和重構來實現。
示例:
<!-- Not so great -->
<span class="avatar">
<img src="...">
</span>
<!-- Better -->
<img class="avatar" src="...">
JavaScript生成的標簽:
通過JavaScript生成的標簽讓內容變得不易查找、編輯。并且降低性能。能避免時盡量避免。
Css
語法:
l 用兩個空格來代替制表符(tab)--這是唯一能保證在所有環境下獲得一致展現的方法;
l 為選擇器分組時,將單獨的選擇器單獨放一行;
l 為了代碼的易讀性,在每行聲明塊的左花括號前添加一個空格;
l 聲明塊的右花括號應當單獨成行;
l 每條聲明語句的:后應該插入一個空格;
l 為了獲得更標準的錯誤報告,每條聲明都應該獨占一行;
l 所有聲明語句都應當以分號結尾。最后一條聲明語句后面的分號是可選的,但是,如果省略這個分號,你的代碼可能更容易出錯;
l 對于以逗號分隔的屬性值,每個逗號后面都應該插入一個空格(例如:box-shadow);
l 不要在rgb()、rgba()、hsl()、hsla()或rect()值的內部的逗號后面插入空格。這樣利于從多個屬性值(加逗號也加空格)中區分多個顏色值(只加逗號,不加空格);
l 對于屬性值或顏色參數,省略小于1的小數前面的0(例如:.5代替0.5、-.5px代替-0.5px);
l 十六進制值應該全部小寫,例如:#fff。在描寫文檔時,小寫字符易于分辨,因為他們的形式更易于區分;
l 盡量使用簡寫形式的十六進制,例如:用#fff替換#ffffff;
l 為選擇器的屬性添加雙引號,例如:input[type=”text”]。只有在某些情況下是可選的(http://mathiasbynens.be/notes/unquoted-attribute-values#css),但是,為了代碼的一致性,建議都加上雙引號;
l 避免為0值指定單位,例如:用margin:0;代替margin:0px;。
對于此處用到的術語,可參考syntax section of the Cascading Style Sheets article(http://en.wikipedia.org/wiki/Cascading_Style_Sheets#Syntax)。
示例:
/* 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;
}
聲明順序:
相關的屬性聲明應當歸為一組,并按照下面的順序排列:
1. Positioning;
2. Box model;
3. Typographic;
4. Visual。
由于定位(positioning)可以從正常的文檔流中移除元素,并且還能覆蓋盒模型(box model)相關的樣式,因此排在首位。盒模型排在第二位,因為它決定了組件的尺寸和位置。
其他屬性只是影響組件的內部(inside)或者是不影響前兩組屬性,因此排在后面。
完整的屬性列表及其排列順序請參考Recess(http://twitter.github.com/recess)。
示例:
.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;
}
不要使用@import:
與<link>標簽相比,@import指令要慢很多,不光增加了額外的請求次數,還會導致不可預料的問題。替代的辦法有以下幾種:
l 使用多個<link>元素;
l 通過Sass或Less類似的Css預處理器將多個Css文件便以為一個文件;
l 通過Rails、Jekyll或其他系統中提供過Css文件合并功能。
請參考Steve Souders的文章(http://www.stevesouders.com/blog/2009/04/09/dont-use-import/)了解更多知識。
示例:
<!-- Use link elements -->
<link rel="stylesheet" href="core.css">
<!-- Avoid @imports -->
<style>
@import url("more.css");
</style>
媒體查詢(Media query)的位置:
將媒體查詢放在盡可能相關規則的附近。不要將他們打包放在一個單一樣式文件中或者放在文檔底部。如果你把他們分開了,將來只會被大家遺忘。下面給出一個典型的實例。
示例:
.element { ... }
.element-avatar { ... }
.element-selected { ... }
@media (min-width: 480px) {
.element { ...}
.element-avatar { ... }
.element-selected { ... }
}
帶前綴的屬性:
當使用特定廠商的帶有前綴的屬性時,通過縮進的方式,讓每個屬性的值在垂直方向對齊,這樣便于多行編輯。
在 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);
}
單行規則聲明:
對于只包含一條聲明的樣式,為了易讀性和快速編輯,建議將語句放在同一行。對于帶多條聲明的樣式,還是應當將聲明分為多行。
這樣做的關鍵因素是為了錯誤檢測--例如:Css校驗器指出在183行有語法錯誤。如果是單行聲明,你就不會忽略這個錯誤;如果是多行聲明的話,你就要仔細的分析了。
示例:
/* 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; }
簡單形式的屬性聲明:
在需要顯示地設置所有值的情況下,應當盡量限制使用簡寫形式的屬性聲明。常見的濫用簡寫屬性聲明的情況如下:
l padding;
l margin;
l font;
l background;
l border;
l border-radius。
大部分情況下,我們不需要為簡寫形式的屬性聲明指定所有值。例如:Html的heading元素只需要設置上、下邊距(margin)的值,因此,在必要的時候,只需要覆蓋這兩個值就可以。過度使用簡寫形式的屬性聲明會導致代碼混亂,并且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。
MDN(Mozilla Developer Network)上一片非常好的關于shorthand properties 的文章(https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties),對于不太熟悉簡寫屬性聲明及其行為的用戶很有用。
示例:
/* 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;
}
Less和Sass中的嵌套:
避免非必要的嵌套。這是因為你雖然可以使用嵌套,但是并不意味著應該使用嵌套。只有在必須將樣式限制在父元素內(也就是后代選擇器),并且存在多個需要嵌套的元素時才使用嵌套。
示例:
// Without nesting
.table > thead > tr > th { … }
.table > thead > tr > td { … }
// With nesting
.table > thead > tr {
> th { … }
> td { … }
}
注釋:
代碼是由人編寫維護的。請確保你的代碼能夠自描述、注釋良好并且易于他人理解。好的代碼注釋能夠傳達上下文關系和代碼目的。不要簡單地重申組件或class名稱。
對于較長的注釋,務必書寫完整的句子;對于一般性的注釋,可以書寫簡潔的短語。
示例:
/* Bad example */
/* Modal header */
.modal-header {
...
}
/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
...
}
class命名:
l class名稱中只能出現小寫字符和破折號(dashe)(不是下劃線,也不是駝峰命名法)。破則好應當用于相關class的命名(類似于命名空間)(例如:.btn和.btn-danger);
l 避免過度的任意簡寫。.btn代表button,但是.s不代表任何意思;
l class名稱應當盡可能短,并且意義明確;
l 使用有意義的名稱。使用有組織的或目的明確的名稱,不要使用表現形式(presentational)的名稱;
l 基于最近的父class或基本(base)class作為新class的前綴;
l 使用.js-*class來標識行為(與樣式相對),并且不要將這些class包含到Css文件中。
在為Sass和Less變量命名時也可以參考上面列出的各項規范。
示例:
/* Bad example */
.t { ... }
.red { ... }
.header { ... }
/* Good example */
.tweet { ... }
.important { ... }
.tweet-header { ... }
選擇器:
l 對于通用元素使用class,這樣有利于渲染性能的優化;
l 對于經常出現的組件,避免使用屬性選擇器(例如:[class^=”...”])。瀏覽器的性能會受到這些因素的影響;
l 選擇器要盡可能短,并且盡量限制組成選擇器的元素個數,建議不要超過3;
l 只有在必要的時候才將class限制在最近的父元素內(也就是后代選擇器)(例如:不適用帶前綴的class時--前綴類似于命名空間)。
擴展閱讀:
Scope CSS classes with prefixes(http://markdotto.com/2012/02/16/scope-css-classes-with-prefixes/)
Stop the cascade(http://markdotto.com/2012/03/02/stop-the-cascade/)
示例:
/* Bad example */
span { ... }
.page-container #stream .stream-item .tweet .tweet-header .username { ... }
.avatar { ... }
/* Good example */
.avatar { ... }
.tweet-header .username { ... }
.tweet .avatar { ... }
代碼組織:
l 以組件為單位組織代碼段;
l 指定一致的注釋規范;
l 使用一致的空白符將代碼分割成塊,這樣利于掃描較大的文檔;
l 如果使用了多個Css文件,將其按照組件而非頁面的形式分拆,因為頁面會被重組,而組件只會被移動。
示例:
/*
* 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 { ... }
編輯器配置:
將你的編輯器按照下面的配置進行設置,以免常見的代碼不一致和差異:
l 兩個空格代替制表符(soft-tab即用空格代表tab符);
l 保存文件時,刪除尾部的空白符;
l 設置文件編碼為UTF-8;
l 在文件的結尾添加一個空白行。
選擇我們,優質服務,不容錯過
1. 優秀的網絡資源,強大的網站優化技術,穩定的網站和速度保證
2. 15年上海網站建設經驗,優秀的技術和設計水平,更放心
3. 全程省心服務,不必擔心自己不懂網絡,更省心。
------------------------------------------------------------
24小時聯系電話:021-58370032