天天看點

選項中css樣式書寫正确的是,CSS樣式書寫規範

原标題:CSS樣式書寫規範

可能不同團隊都有各自的規範,又或者很多人在寫 CSS 的時候還是想到什麼就寫什麼,不存在太多的限制。

我覺得 CSS 代碼規範還是有存在的必要的,尤其是在團隊配合,多人協作下,規範就顯得尤為重要。

本文的所列是實踐當中得出的一套比較不錯的 CSS 書寫規範,并不希望大家完全采用,而是希望可以結合自己的團隊需要,發展出一套适合自己的 CSS 代碼規範。

也希望可以有更多的建議,共同的完善。本規範也可以在我的 Github 上看到,歡迎留言或者提 PR。

我覺得不同的規範都有各自的長處與缺陷,對待所謂的規範最好的方式不是人雲亦雲,拿來就用,而是應該結合實際情況及需求,取長補短,取其精華去其糟粕。

編碼設定

采用 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-。

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

元件:以 m 為命名空間,表示可複用、移植的元件子產品,例如:m-slider、m-dropMenu。

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

命名空間思想

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

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

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

能良好區分 Java 變量命名

字元小寫

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

選擇器

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

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

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

.g-content~.g-footer{

}

命名短且語義化良好

對于選擇器的命名,盡量簡潔且具有語義化,不應該出現 g-abc 這種語義模糊的命名。

規則聲明塊

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

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

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

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

規則聲明塊的右大括号 } 獨占一行。

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

所有最外層引号使用單引号 ‘ 。

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

完整示例如下:

.g-footer,

.g-header{

position:relative;

}

.g-content{

background:

linear-gradient(135deg,deeppink25%,transparent25%)-50px0,

linear-gradient(225deg,deeppink25%,transparent25%)-50px0,

linear-gradient(315deg,deeppink25%,transparent25%),

linear-gradient(45deg,deeppink25%,transparent25%);

}

.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','黑體-簡','5b8b4f53';

}

background-image 的 url 内使用引号

如果路徑裡面有空格,舊版 IE 是無法識别的,會導緻路徑失效,建議不管是否存在空格,都添加上單引号或者雙引号:

div{

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

}

避免使用 !important

除去某些極特殊的情況,盡量不要不要使用 !important。

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

當存在樣式覆寫層疊時,如果你發現新定義的一個樣式無法覆寫一個舊的樣式,隻有加上 !important 才能生效時,是因為你新定義的選擇器的優先級不夠舊樣式選擇器的優先級高。是以,合理的書寫新樣式選擇器,是完全可以規避一些看似需要使用 !important 的情況的。

代碼注釋

單行注釋

星号與内容之間必須保留一個空格。

多行注釋

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

規則聲明塊内注釋

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

.g-footer{

border:0;

// ....

}

檔案注釋

檔案頂部必須包含檔案注釋,用 @name 辨別檔案說明。星号要一列對齊,星号與内容之間必須保留一個空格,辨別符冒号與内容之間必須保留一個空格。

@deion為檔案或子產品描述。

@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 結構: