本文整理的是一份團隊內部使用的 CSS 代碼規範(V1.0),側重基礎約定。規範的價值不在於限制,而在於讓任何一個成員的產出都能被其他人直接接手。
文件頭部必須寫明基本信息,包括用途說明、作者、最後更新(更新人 + 時間):
/* *@Description: public common css (可寫中文) *@Author: sev7n *@Update: sev7n(2011-08-09 17:22) */
CSS 內部注釋的格式,參照團隊的《UED 前端注釋規範》。
頁面主要使用 gb2312 編碼,因此 CSS 文件的編碼必須與頁面保持一致,不要把樣式文件單獨存成 utf-8。
為避免文件合併與編碼轉換時出問題,樣式中若出現中文字體名,建議改寫成對應英文名,例如黑體寫 SimHei、宋體寫 SimSun、微軟雅黑寫 Microsoft Yahei(由多個單詞組成、含空格的必須加引號)。
xxx-yyy,不出現大寫字母。xxx-mod 命名(-mod 可省略),其內部再拆 xxx-hd(頭部)、xxx-bd(內容)、xxx-ft(底部)。建議按「顯示 → 盒模型 → 文本 → 邊框背景 → 層級」分組,同組內大致按下列順序:
display | position | float | clear | cursor …margin | padding | width | heightvertical-align | white-space | text-decoration | text-align | color | font | content …border | backgroundoverflow | z-index | zoom5.1 禁用 expression 表達式。
5.2 禁止濫用 !important。使用前必須確認不會引入其他 bug 或增加維護成本。
5.3 少用濾鏡,少用 hack。能不解決就別解,能不 hack 堅決不 hack。
5.4 層級必須清晰。頁面彈窗、氣泡屬於最高級(頂格 999,如 showWin、pop),不同彈窗之間可在三位數內調整;普通區塊控制在 10–90 之間取 10 的倍數;區塊展開或彈出,就在當前父層級的個位上遞增。禁止層級互相攀比。
以一段結構為例:
<ul class="post-bd">
<li class="post-to">
<div class="post-tag"></div>
<div class="post-add"></div>
</li>
<li class="post-editor"></li>
<li class="post-app"></li>
</ul>
錯誤寫法——毫無規律地攀比:
.post-to {z-index:999;}
.post-tag {z-index:99;}
.post-add {z-index:9;}
.post-editor {z-index:99;}
.post-app {z-index:9;}
正確寫法——層級遞減且留有餘量:
.post-to {z-index:90}
.post-tag {z-index:99}
.post-add {z-index:98}
.post-editor {z-index:80}
.post-app {z-index:70}
5.5 保持可讀性。代碼必須縮進,CSS 結構盡量對應 HTML 結構(但不必縮進太深,能看出層次即可);選擇器與左花括號之間留一個空格;括號內不要多餘的空格和換行。
錯誤:
.post-to{z-index:999 ; }
.post-tag{z-index:99; }
.post-add{z-index:9 ;}
正確:
.post-to {z-index:999}
.post-tag {z-index:99}
.post-add {z-index:9}
5.6 簡化選擇器。在保證精準的前提下盡量不超過四級,並刪掉冗餘部分,比如 class/id 前面的標籤選擇器、li 上一層的 ul/ol、dt/dd 上一層的 dl 等。
冗餘:
div#post-to {}
.post-app dl dt {}
.post-app ul li.post-xxx {}
精簡後:
#post-to {}
.post-app dt {}
.post-app .post-xxx {}
5.7 字重寫具體數值。粗體 bold 寫 700,常規 normal 寫 400。
5.8 能縮寫就縮寫。margin、padding、font(font-style / font-variant / font-weight / font-size/line-height / font-family)、border(width / style / color)、background(color / image / repeat / attachment / position)等。
冗長:
.post-tag {margin:2px;margin-right:5px;font-weight: bold;font-size:14px;line-height:24px;font-family:"黑體"}
縮寫後:
.post-tag { margin:2px 5px 2px 2px; font: 700 14px/24px "黑體"}
5.9 數值與顏色規範。0 值後面不帶單位(不出現 0px 這種寫法);顏色不用 red、blue 之類關鍵字,一律寫成 # 加十六進制(CSS3 的 rgb/rgba 除外);大小寫不做強制,也不強制把六位縮成三位。
規範:
.post-tag {margin:0 0 1px 1px;color:#FFFFFF;background:#fff}