Css 編碼規範

基礎(Base) 規則是HTML元素的默認樣式,如連接,段落和標題。
佈局(Layout) 規則將頁面分紅幾個部分,並將一個或多個模塊組合在一塊兒。它們只定義佈局,而無論顏色或排版。
模塊(Module)(又名「對象」或「塊」)是可重用的,設計中的一個模塊。例如,按鈕,媒體對象,產品列表等。
狀態(State) 規則描述了模塊或佈局在特定狀態下的外觀。一般使用 JavaScript 應用或刪除。例如,隱藏,擴展,激活等。
主題(Theme) 規則描述了模塊或佈局在主題應用時的外觀,例如,在 Yahoo Mail 中,可使用用戶主題,這會影響頁面上的每一個模塊。(這很是適用於像雅虎這樣的應用程序,但大多數網站都不會使用此類別。)html

命名約定前綴
下一個原則是使用前綴來區分類別,他喜歡 BEM 明確的命名約定,但他還但願可以一目瞭然地看出模塊的類型。瀏覽器

l- 用做佈局規則的前綴:l-inline
m- 用做模塊規則的前綴:m-callout
is- 用做狀態規則的前綴:is-collapsed框架

(基礎規則沒有前綴,由於它們直接應用於 HTML 元素而不使用類。)
共享模塊化原則
這些框架的相同之處遠勝於其不一樣之處。我看到從 OOCSS 到 BEM 再到 SMACSS 的明確發展。它們的發展表明了咱們行業在性能和大規模 CSS 領域不斷增加的經驗。
你沒必要選擇其中一個框架,相反,咱們能夠嘗試定義模塊化 CSS 的通用規則。讓咱們看看這些框架共用和保留的最佳部分。
模塊化元素
模塊化系統由如下元素組成:dom

模塊(Module):(又名對象,塊或組件)一種可複用且自成一體的模式。如媒體對象,導航和頁眉。
子元素(Child Element): 一個不能獨立存在的小塊,屬於模塊的一部分。如媒體對象中的圖像,導航選項卡和頁眉 logo。
模塊修改器(Module Modifier):(又名皮膚或主題)改變模塊的視覺外觀。如左/右對齊的媒體對象,垂直/水平導航。ide

模塊化類別
模塊化系統中的樣式能夠分爲如下幾類:模塊化

基礎(Base) 規則是 HTML 元素的默認樣式,如:a、li 和 h1
佈局(Layout) 規則控制模塊的佈局方式,但不控制視覺外觀,如:.l-centered、.l-grid 和 .l-fixed-top
模塊(Modules) 是可複用的,獨立的 UI 組件視覺樣式,如:.m-profile、.m-card 和 .m-modal
狀態(State) 規則由 JavaScript 添加,如:.is-hidden、.is-collapsed 和 .is-active
助手(Helper)(又名功能)規則適用範圍小,獨立於模塊,如:.h-uppercase、.h-nowrap 和 .h-muted工具

模塊化規則
在模塊化系統中編寫樣式時,請遵循如下規則:佈局

不要使用 ID
CSS 嵌套不要超過一層
爲子元素添加類名
遵循命名約定
爲類名添加前綴性能

採用 UTF-8 編碼,在 CSS 代碼頭部使用:字體

@charset "utf-8";

注意,必需要定義在 CSS 文件全部字符的前面(包括編碼註釋),@charset 纔會生效。

例如,下面的例子都會使得 @charset 失效:

/* 字符編碼 */

@charset "utf-8";

html,

body {

height: 100%;

}

@charset "utf-8";

命名空間規範

佈局:以 g 爲命名空間,例如:.g-wrap 、.g-header、.g-content。

狀態:以 s 爲命名空間,表示動態的、具備交互性質的狀態,例如:.s-current、s-selected。

工具:以 u 爲命名空間,表示不耦合業務邏輯的、可複用的的工具,例如:u-clearfix、u-ellipsis。

組件:以 m 爲命名空間,表示可複用、移植的組件模塊,例如:m-slider、m-dropMenu。

鉤子:以 j 爲命名空間,表示特定給 JavaScript 調用的類名,例如:j-request、j-open。

命名空間思想

沒有選擇 BEM 這種命名過於嚴苛及樣式名過長過醜的規則,採起了一種比較折中的方案。

不建議使用下劃線 _ 進行鏈接

節省操做,輸入的時候少按一個 shift 鍵

能良好區分 JavaScript 變量命名

字符小寫

定義的選擇器名,屬性及屬性值的書寫皆爲小寫。

選擇器

當一個規則包含多個選擇器時,每一個選擇器獨佔一行。

、+、~、> 選擇器的兩邊各保留一個空格。

.g-header > .g-header-des,

.g-content ~ .g-footer {

}

命名短且語義化良好

對於選擇器的命名,儘可能簡潔且具備語義化,不該該出現 g-abc 這種語義模糊的命名。

規則聲明塊

當規則聲明塊中有多個樣式聲明時,每條樣式獨佔一行。

在規則聲明塊的左大括號 { 前加一個空格。

在樣式屬性的冒號 : 後面加上一個空格,前面不加空格。

在每條樣式後面都以分號 ; 結尾。

規則聲明塊的右大括號 } 獨佔一行。

每一個規則聲明間用空行分隔。

全部最外層引號使用單引號 ‘ 。

當一個屬性有多個屬性值時,以逗號 , 分隔屬性值,每一個逗號後添加一個空格,當單個屬性值過長時,每一個屬性值獨佔一行。

完整示例以下:

.g-footer,

.g-header {

position: relative;

}

.g-content {

background:

linear-gradient(135deg, deeppink 25%, transparent 25%) -50px 0,

linear-gradient(225deg, deeppink 25%, transparent 25%) -50px 0,

linear-gradient(315deg, deeppink 25%, transparent 25%),

linear-gradient(45deg, deeppink 25%, transparent 25%);

}

.g-content::before {

content: '';

}

數值與單位

當屬性值或顏色參數爲 0 – 1 之間的數時,省略小數點前的 0 。color: rgba(255, 255, 255, 0.5)color: rgba(255, 255, 255, .5);

當長度值爲 0 時省略單位。margin: 0px automargin: 0 auto

十六進制的顏色屬性值使用小寫和儘可能簡寫。color: #ffcc00color: #fc0

樣式屬性順序

單個樣式規則下的屬性在書寫時,應按功能進行分組,並以 Positioning Model > Box Model > Typographic > Visual 的順序書寫,提升代碼的可讀性。

若是包含 content 屬性,應放在最前面;

Positioning Model 佈局方式、位置,相關屬性包括:position / top / right / bottom / left / z-index / display / float / …

Box Model 盒模型,相關屬性包括:width / height / padding / margin / border / overflow / …

Typographic 文本排版,相關屬性包括:font / line-height / text-align / word-wrap / …

Visual 視覺外觀,相關屬性包括:color / background / list-style / transform / animation / transition / …

Positioning 處在第一位,由於他可使一個元素脫離正常文本流,而且覆蓋盒模型相關的樣式。盒模型緊跟其後,由於他決定了一個組件的大小和位置。其餘屬性只在組件內部起做用或者不會對前面兩種狀況的結果產生影響,因此他們排在後面。

合理使用使用引號

在某些樣式中,會出現一些含有空格的關鍵字或者中文關鍵字。

font-family 內使用引號

當字體名字中間有空格,中文名字體及 Unicode 字符編碼表示的中文字體,爲了保證兼容性,都建議在字體兩端添加單引號或者雙引號:

body {

font-family: 'Microsoft YaHei', '黑體-簡', '\5b8b\4f53';

}

background-image 的 url 內使用引號

若是路徑裏面有空格,舊版 IE 是沒法識別的,會致使路徑失效,建議不論是否存在空格,都添加上單引號或者雙引號:

div {

background-image: url('...');

}

避免使用 !important

除去某些極特殊的狀況,儘可能不要不要使用 !important。

!important 的存在會給後期維護以及多人協做帶來噩夢般的影響。

當存在樣式覆蓋層疊時,若是你發現新定義的一個樣式沒法覆蓋一箇舊的樣式,只有加上 !important 才能生效時,是由於你新定義的選擇器的優先級不夠舊樣式選擇器的優先級高。因此,合理的書寫新樣式選擇器,是徹底能夠規避一些看似須要使用 !important 的狀況的。

代碼註釋

單行註釋

星號與內容之間必須保留一個空格。

/* 表格隔行變色 */

多行註釋

星號要一列對齊,星號與內容之間必須保留一個空格。

/**

  • Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.

*/

規則聲明塊內註釋

使用 // 註釋,// 後面加上一個空格,註釋獨立一行。

.g-footer {

border: 0;

// ....

}

文件註釋

文件頂部必須包含文件註釋,用 @name 標識文件說明。星號要一列對齊,星號與內容之間必須保留一個空格,標識符冒號與內容之間必須保留一個空格。

/**

  • @name: 文件名或模塊名

  • @description: 文件或模塊描述

  • @author: author-name(mail-name@domain.com)

  • author-name2(mail-name2@domain.com)
  • @update: 2015-04-29 00:02

*/

@description爲文件或模塊描述。

@update爲可選項,建議每次改動都更新一下。

當該業務項目主要由固定的一個或多我的負責時,須要添加@author標識,一方面是尊重勞動成果,另外一方面方便在須要時快速定位責任人。

SASS 使用建議

嵌套層級規定

使用 SASS 、 LESS 等預處理器時,建議嵌套層級不超過 3 層。

組件/公用類的使用方法

組件/公用類使用 %placeholders 定義,使用 @extend 引用。如:

%clearfix {

overflow: auto;

zoom: 1;

}

.g-header {

@extend %clearfix;

}

組件類的思考

使用 SASS ,常常會預先定義好一些經常使用公用組件類,譬如清除浮動,水平垂直居中,文字 ellipsis。又或者多個元素具備一樣的樣式,咱們但願可以少寫這部分代碼,公共部分抽離出來只寫一次,達到複用。

可是複用的方式在 SASS 中有多種,那麼是使用單獨使用一個類定義,給須要的標籤添加,仍是使用 @include 或者 @extend在定義的類中引入一個 @mixin,或者一個 @function 呢?

基於讓 CSS 更簡潔以及代碼的複用考慮,採用上面的使用 %placeholders 定義,使用 @extend 引用的方案。

%placeholders,只是一個佔位符,只要不經過 @extend 調用,編譯後不會產生任何代碼量

使用 @extend 引用,則是由於每次調用相同的 %placeholders 時,編譯出來相同的 CSS 樣式會進行合併(反之,若是使用 @include 調用定義好的 @mixin,編譯出來相同的 CSS 樣式不會進行合併)

這裏的組件類特指那些不會動態改變的 CSS 樣式,注意與那些能夠經過傳參生成不一樣數值樣式的 @mixin 方法進行區分

儘可能避免使用標籤名

使用 SASS ,或者說在 CSS 裏也有這種困惑。

假設咱們有以下 html 結構:

在給最裏層的標籤命名書寫樣式的時候,咱們有兩種選擇:

.g-content {

.g-content-list {

li {

...

}

}

}

或者是

.g-content {

.g-content-list {

.item {

...

}

}

}

也就是,編譯以後生成了下面這兩個,到底使用哪一個好呢?

.g-content .g-content-list li { }

.g-content .g-content-list .item { }

基於 CSS 選擇器的解析規則(從右向左),建議使用上述第二種 .g-content .g-content-list .item { } ,避免使用通用標籤名做爲選擇器的一環能夠提升 CSS 匹配性能。

瀏覽器的排版引擎解析 CSS 是基於從右向左(right-to-left)的規則,這麼作是爲了使樣式規則可以更快地與渲染樹上的節點匹配。

相關文章
相關標籤/搜索