CSS書寫格式

轉自： https://segmentfault.com/a/1190000005046830



CSS書寫格式

1.格式化代碼

1.1文件

[建議]：CSS文件使用無BOM的UTF-8編碼

1.2縮進

[強制]：使用 4 個空格作爲一個縮進層級，不容許使用 2 個空格 或 tab 字符。

.selector {
    margin: 0;
    padding: 0;
}
1.3空格

[強制]：選擇器 與 { 之間必須包含空格。

.selector {

}
[強制]：選擇器 與 { 之間必須包含空格。

margin: 0;

[強制]：列表性屬性書在單行時，,後必須跟一個空格

font-family: Aria, sans-serif;

1.4行長度

[強制]： 每行不得超過 120 個字符，除非單行不可分割。

[建議]： 對於超長的樣式，在樣式值的 空格 處或 , 後換行，建議按邏輯分組。

/* 不一樣屬性值按邏輯分組 */
background:
    transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
    no-repeat 0 0;

/* 可重複屢次的屬性，每次重複一行 */
background-image:
    url(aVeryVeryVeryLongUrlIsPlacedHere)
    url(anotherVeryVeryVeryLongUrlIsPlacedHere);

/* 相似函數的屬性值能夠根據函數調用的縮進進行 */
background-image: -webkit-gradient(
    linear,
    left bottom,
    left top,
    color-stop(0.04, rgb(88,94,124)),
    color-stop(0.52, rgb(115,123,162))
);
1.5選擇器

[強制]：當一個 rule 包含多個 selector 時，每一個選擇器聲明必須獨佔一行。

/* good */
.post,
.page,
.comment {
    line-height: 1.5;
}

/* bad */
.post, .page, .comment {
    line-height: 1.5;
}
[強制]： >、+、~ 選擇器的兩邊各保留一個空格。

示例：

/* good */
main > nav {
    padding: 10px;
}

label + input {
    margin-left: 5px;
}

input:checked ~ button {
    background-color: #69C;
}

/* bad */
main>nav {
    padding: 10px;
}

label+input {
    margin-left: 5px;
}

input:checked~button {
    background-color: #69C;
}
[強制] 屬性選擇器中的值必須用雙引號包圍。

css
/* good */
article[character="juliet"] {
    voice-family: "Vivien Leigh", victoria, female
}

/* bad */
article[character='juliet'] {
    voice-family: "Vivien Leigh", victoria, female
}
2.選擇器與屬性縮寫

2.1選擇器

[強制] 如無必要，不得爲 id、class 選擇器添加類型選擇器進行限定。

解釋：在性能和維護性上，都有必定的影響。

示例：

css
/* good */
#error,
.danger-message {
    font-color: #c00;
}

/* bad */
dialog#error,
p.danger-message {
    font-color: #c00;
}
[建議] 選擇器的嵌套層級應不大於 3 級，位置靠後的限定條件應儘量精確。

示例：

/* good */
#username input {}
.comment .avatar {}

/* bad */
.page .header .login #username input {}
.comment div * {}
2.2 屬性縮寫

[建議] 在可使用縮寫的狀況下，儘可能使用屬性縮寫。

示例：

/* good */
.post {
    font: 12px/1.5 arial, sans-serif;
}

/* bad */
.post {
    font-family: arial, sans-serif;
    font-size: 12px;
    line-height: 1.5;
}
[建議] 使用 border / margin / padding 等縮寫時，應注意隱含值對實際數值的影響，確實須要設置多個方向的值時才使用縮寫。

解釋：border / margin / padding 等縮寫會同時設置多個屬性的值，容易覆蓋不須要覆蓋的設定。如某些方向須要繼承其餘聲明的值，則應該分開設置。

示例：

/* centering <article class="page"> horizontally and highlight featured ones */
article {
    margin: 5px;
    border: 1px solid #999;
}

/* good */
.page {
    margin-right: auto;
    margin-left: auto;
}

.featured {
    border-color: #69c;
}

/* bad */
.page {
    margin: 5px auto; /* introducing redundancy */
}

.featured {
    border: 1px solid #69c; /* introducing redundancy */
}
2.3 每一個規則集之間保留一個空行

/* good */
.selector1 {
  display: block;
  width: 100px;
}
.selector2 {
  padding: 10px;
  margin: 10px auto;
}

/* bad */
.selector1 {
  display: block;
  width: 100px;
}

.selector2 {
  padding: 10px;
  margin: 10px auto;
}
3.值與單位

3.1 文本

[強制] 文本內容必須用雙引號包圍。

解釋：文本類型的內容可能在選擇器、屬性值等內容中。
示例：

/* good */
html[lang|="zh"] q:before {
    font-family: "Microsoft YaHei", sans-serif;
    content: "「";
}

html[lang|="zh"] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "」";
}

/* bad */
html[lang|=zh] q:before {
    font-family: 'Microsoft YaHei', sans-serif;
    content: '「';
}

html[lang|=zh] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "」";
}
3.2 數值

[強制] 當數值爲 0 - 1 之間的小數時，省略整數部分的 0。

示例：

/* good */
panel {
    opacity: .8
}

/* bad */
panel {
    opacity: 0.8
}
4.3 url()

[強制] url() 函數中的路徑不加引號。

示例：

body {
    background: url(bg.png);
}
3.3 長度

[強制] 長度爲 0 時須省略單位。 (也只有長度單位可省)

示例：

/* good */
body {
    padding: 0 5px;
}

/* bad */
body {
    padding: 0px 5px;
}
3.4 顏色

[強制] RGB顏色值必須使用十六進制記號形式 #rrggbb。不容許使用 rgb()。

/* good */
.success {
    box-shadow: 0 0 2px rgba(0, 128, 0, .3);
    border-color: #008000;
}

/* bad */
.success {
    box-shadow: 0 0 2px rgba(0,128,0,.3);
    border-color: rgb(0, 128, 0);
}
[強制] 顏色值能夠縮寫時，必須使用縮寫形式。

示例：

/* good */
.success {
    background-color: #aca;
}

/* bad */
.success {
    background-color: #aaccaa;
}
[強制] 顏色值不容許使用命名色值。

示例：

/* good */
.success {
    color: #90ee90;
}

/* bad */
.success {
    color: lightgreen;
}
[建議] 顏色值中的英文字符采用小寫。如不用小寫也須要保證同一項目內保持大小寫一致。

示例：

/* good */
.success {
    background-color: #aca;
    color: #90ee90;
}

/* good */
.success {
    background-color: #ACA;
    color: #90EE90;
}

/* bad */
.success {
    background-color: #ACA;
    color: #90ee90;
}
3.5 2D 位置

[強制] 必須同時給出水平和垂直方向的位置。

解釋：
2D 位置初始值爲 0% 0%，但在只有一個方向的值時，另外一個方向的值會被解析爲 center。爲避免理解上的困擾，應同時給出兩個方向的值。background-position屬性值的定義

示例：

/* good */
body {
    background-position: center top; /* 50% 0% */
}

/* bad */
body {
    background-position: top; /* 50% 0% */
}
4.文本編排

4.1 字體族

[強制] font-family 屬性中的字體族名稱應使用字體的英文 Family Name，其中若有空格，須放置在引號中。

解釋：
所謂英文 Family Name，爲字體文件的一個元數據，常見名稱以下：

字體    操做系統    Family Name
宋體 (中易宋體)    Windows    SimSun
黑體 (中易黑體)    Windows    SimHei
微軟雅黑    Windows    Microsoft YaHei
微軟正黑    Windows    Microsoft JhengHei
華文黑體    Mac/iOS    STHeiti
冬青黑體    Mac/iOS    Hiragino Sans GB
文泉驛正黑    Linux    WenQuanYi Zen Hei
文泉驛微米黑    Linux    WenQuanYi Micro Hei
示例：

h1 {
    font-family: "Microsoft YaHei";
}
[強制] font-family 按「西文字體在前、中文字體在後」、「效果佳 (質量高/更能知足需求) 的字體在前、效果通常的字體在後」的順序編寫，最後必須指定一個通用字體族( serif / sans-serif )

解釋：
更詳細說明可參考本文。

示例：

/* Display according to platform */
.article {
    font-family: Arial, sans-serif;
}

/* Specific for most platforms */
h1 {
    font-family: "Helvetica Neue", Arial, "Hiragino Sans GB", "WenQuanYi Micro Hei", "Microsoft YaHei", sans-serif;
}
[強制] font-family 不區分大小寫，但在同一個項目中，一樣的 Family Name 大小寫必須統一。

示例：

/* good */
body {
    font-family: Arial, sans-serif;
}

h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}

/* bad */
body {
    font-family: arial, sans-serif;
}

h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}
4.2 字號

[強制] 須要在 Windows 平臺顯示的中文內容，其字號應不小於 12px。

解釋：因爲 Windows 的字體渲染機制，小於 12px 的文字顯示效果極差、難以辨認。

4.3 字體風格

[建議] 須要在 Windows 平臺顯示的中文內容，不要使用除 normal 外的 font-style。其餘平臺也應慎用。

解釋：
因爲中文字體沒有 italic 風格的實現，全部瀏覽器下都會 fallback 到 obilique 實現 (自動擬合爲斜體)，小字號下 (特別是 Windows 下會在小字號下使用點陣字體的狀況下) 顯示效果差，形成閱讀困難。

6 變換與動畫

[強制] 使用 transition 時應指定 transition-property。

示例：

/* good */
.box {
    transition: color 1s, border-color 1s;
}

/* bad */
.box {
    transition: all 1s;
}
[建議] 儘量在瀏覽器能高效實現的屬性上添加過渡和動畫。

解釋：
見本文，在可能的狀況下應選擇這樣四種變換：

transform: translate(npx, npx);

transform: scale(n);

transform: rotate(ndeg);

opacity: 0..1;

典型的，可使用 translate 來代替 left 做爲動畫屬性。
示例：

/* good */
.box {
    transition: transform 1s;
}
.box:hover {
    transform: translate(20px); /* move right for 20px */
}

/* bad */
.box {
    left: 0;
    transition: left 1s;
}
.box:hover {
    left: 20px; /* move right for 20px */
}
7 響應式

[強制] Media Query 若是有多個逗號分隔的條件時，應將每一個條件放在單獨一行中。

示例：

@media
(-webkit-min-device-pixel-ratio: 2), /* Webkit-based browsers */
(min--moz-device-pixel-ratio: 2),    /* Older Firefox browsers (prior to Firefox 16) */
(min-resolution: 2dppx),             /* The standard way */
(min-resolution: 192dpi) {           /* dppx fallback */
    /* Retina-specific stuff here */
}
CSS註釋

普通註釋

/* 普通註釋 */

區塊註釋

/**
 * 模塊：m-detail
 * author: xxx
 * edit:   2016.5.02
 */
CSS命名規範

命名組成

命名必須由單詞，中劃線組成。例如:.info,.news-list

不推薦使用拼音來做爲樣式名，尤爲是縮寫的拼音、拼音與英文的混合

全部命名都使用小寫,使用中劃線 「-」 做爲鏈接字符，而不是下劃線 「_「

命名前綴

前綴    說明    示例
g-    全局通用樣式命名    g-mod
m-    模塊命名方式    m-detail
ui-    組件命名方式    ui-selector
j-    全部用於純交互的命名，不涉及任何樣式規則。    J-switch
不容許出現以相似：.info, .current, .news 開頭的選擇器，好比：

.info{sRules;} 
由於這樣將給咱們帶來不可預知的管理麻煩以及沉重的歷史包袱。你永遠也不會知道哪些樣式名已經被用掉了，若是你是一個新人，你可能會遭遇，你每定義個樣式名，都有同名的樣式已存在，而後你只能是換樣式名或者覆蓋規則。因此咱們推薦這樣寫：

.m-xxx .info{sRules;}
全部的選擇器必須是以 g-, m-, ui- 等有前綴的選擇符開頭的，意思就是說全部的規則都必須在某個相對的做用域下才生效，儘量減小全局污染。 J- 這種級別的className徹底交由JSer自定義，可是命名的規則也能夠保持跟重構一致，好比說不能使用拼音之類的

命名單詞

不以表現來命名，而是根據內容來命名。好比：left, right, center, red, black這種以表現來定命名，不容許出現；

推薦使用功能和內容相關詞彙的命名，如:

套系:package
相冊:photo-album
做品:works
攻略:raiders
普通用戶:normal-user 
達人:talent-user
攝影師:photographer
用戶暱稱:user-alias
頭像:head
地區:area
關注數:follow
粉絲數:followers
互相注意:attention
標籤:label
發表時間:publish-date,publish-time
標題:title
信息:info
內容:content
關於我:about
簡介內容:intro-content
評論:review 
服務:service
封面:cover
流行:popular
收藏:collect
查看:view
預定:reservation
促銷:sale-promotion
(待補充)

編輯器配置

將你的編輯器按照下面的配置進行設置，以免常見的代碼不一致和差別：

使用4個空格縮進

使用Unix風格換行符(LF)

保存文件時，刪除尾部的空白符。

設置文件編碼爲 UTF-8。

在文件結尾添加一個空白行。

參照文檔並將這些配置信息添加到項目的 .editorconfig文件中。

// 示例
# css-creating coding style
root = true

# 爲全部文件設置風格
[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

# 爲 Markdown 文件保留行尾空格
[*.md]
trim_trailing_whitespace = false