團隊開發時,CSS 的撰寫風格若不一致,後期的維護成本會急遽上升。以下是 Discuz X 系列的一套實用規範,值得直接拿來當作專案約定。
格式規範
屬性寫在同一行內,屬性之間、屬性名與值之間、以及屬性與大括號之間都要留一個空格:
.class { width: 400px; height: 300px; }
屬性書寫順序
依「由外而內、由整體到細節」的原則,大致分成五組:
- 定位:position、left、right、float
- 盒模型:display、margin、padding、width、height
- 邊框與背景:border、background
- 段落與文字:line-height、text-indent、font、color、text-decoration 等
- 其他:overflow、cursor、visibility 等
針對特定瀏覽器的私有屬性,要寫在標準屬性之前,例如 -webkit-box-shadow、-moz-box-shadow,最後才是 box-shadow,這樣標準屬性才會取得最終優先權。
選擇器與命名
- 謹慎新增選擇器規則,尤其不要濫用 id,優先繼承與複用既有樣式。
- 選擇器、屬性、值一律小寫(顏色的格式寫法除外)。縮寫名稱需註明全稱,例如
.cl -> Clearfix。
- 避免各種 CSS Hack;若必須為 IE 做特殊定義,請統一參照專案內的 Hack 說明章節。
- 不要寫冗長低效的後代選擇器,例如
ul li a span { ... }。
- 慎用
!important,它會讓後續覆蓋變成噩夢。
建議的命名用詞
- 表示狀態:a → active
- 表示結構:h → header、c → content、f → footer
- 表示區域:mn → main、sd → side、nv → navigation、mu → menu
- 表示樣式:l → list、tab、p_pop
最後一條容易被忽略但很實用:開發過程中尚未定案的項目,用 [!] 標記出來,方便後續討論與整理。