萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網頁製作 >> Div CSS 教學

CSS 命名規範:模塊化、語義化、可維護的 Class/ID 命名體系設計

命名是工程化的基石。混亂的命名導致樣式衝突、難以復用、團隊協作成本激增。本文提出基於「模塊前綴 | 類型 | 作用」的結構化命名規範,配合常用縮寫表,構建可擴展、低認知負荷的 CSS 架構。

核心命名原則

  1. 語義化而非表現化:.news-list ✅ / .red-box ❌(顏色變更時名稱失真)
  2. 小寫 + 連字符:.module-type-name,不使用駝峰、下劃線、大寫
  3. ID 唯一、Class 復用:ID 用於頁面級唯一容器/JS 掛載點,Class 用於可復用組件
  4. 模塊前綴隔離作用域:.header-、.nav-、.btn-、.form-,防止全局污染
  5. 狀態/變體後綴標準化:-primary、-secondary、-disabled、-loading、-lg/-sm

結構化命名模式

[模塊前綴]-[類型]-[作用]__[元素]--[狀態|變體]

/* 例子 */
.header__logo           /* Header 模塊的 Logo 元素 */
.nav__item--active      /* Nav 模塊的 Item 元素,Active 狀態 */
.btn--primary--lg       /* Btn 組件,Primary 變體,Large 尺寸 */
.card__title--truncated /* Card 組件 Title 元素,截斷狀態 */

採用 BEM (Block Element Modifier) 變體:雙下劃線 __ 連接元素,雙連字符 -- 連接修飾符,清晰可讀、工具友好。

常用語義縮寫表(團隊統一約定)

語義縮寫適用場景
Container / Wrapperct / wrap外層容器
Header / Footerhd / ft頁頭/頁腳
Navigation / Menunav / menu導航/菜單
Sidebar / Asideside / asd側邊欄
Main / Contentmain / cnt主內容區
Module / Block / Componentmod / blk / comp功能塊
List / Itemlst / itm列表/項
Buttonbtn按鈕
Input / Textareaipt / ta輸入框
Label / Title / Captionlbl / tt / cap標籤/標題
Image / Icon / Avatarimg / icn / avt圖片/圖標/頭像
Link / Anchorlnk鏈接
Form / Field / Groupfm / fld / grp表單/字段/分組
Table / Row / Celltbl / row / cell表格/行/單元格
Pagination / Pagepg / page分頁
Modal / Dialog / Popupmod / dlg / pop彈層
Tooltip / Tips / Hinttip / hint提示
Alert / Notice / Msgalt / ntc / msg警告/通知/消息
Header / Body / Footer (組件內)hd / bd / ft組件內部結構
Primary / Secondary / Danger / Successpri / sec / dan / suc語義色變體
Large / Medium / Small / Minilg / md / sm / xs尺寸變體
Active / Current / Selectedact / cur / sel激活態
Hover / Focus / Disabledhov / fcs / dis交互態
Hidden / Visible / Show / Hidehdn / vis / show / hide顯隱態
Loading / Error / Emptyldg / err / emp數據態

實戰命名示例

按鈕組件體系

.btn                  /* 基礎按鈕 */
.btn--pri               /* 主要按鈕 */
.btn--sec               /* 次要按鈕 */
.btn--dan               /* 危險按鈕 */
.btn--lg / .btn--sm     /* 尺寸變體 */
.btn--block             /* 塊級按鈕 */
.btn--disabled / .btn[disabled]  /* 禁用態 */

表單組件體系

.form__grp            /* 字段分組 */
.form__lbl              /* 標籤 */
.form__ipt              /* 輸入框 */
.form__ipt--err         /* 錯誤態輸入框 */
.form__msg              /* 提示信息 */
.form__msg--err         /* 錯誤提示 */

導航組件體系

.nav                  /* 導航容器 */
.nav__lst               /* 列表 */
.nav__itm               /* 項 */
.nav__lnk               /* 鏈接 */
.nav__itm--act          /* 當前項 */
.nav__lnk--hov          /* 懸停態(如需單獨樣式) */

卡片組件體系

.card
.card__hd / .card__bd / .card__ft
.card__img
.card__ttl
.card__desc
.card__act
.card--bordered / .card--shadow / .card--hoverable

CSS 架構組織建議

css/
├── base/
│   ├── reset.css       /* Normalize + 基礎重置 */
│   ├── variables.css   /* CSS Custom Properties: 色彩、間距、字體、斷點、z-index */
│   └── typography.css  /* 全局排版:標題、段落、鏈接、列表 */
├── layout/
│   ├── grid.css        /* 頁面級網格:container、row、col */
│   ├── header.css
│   ├── footer.css
│   └── sidebar.css
├── components/
│   ├── btn.css
│   ├── form.css
│   ├── nav.css
│   ├── card.css
│   ├── modal.css
│   └── ...
├── utilities/
│   ├── spacing.css     /* m-/p- 工具類 */
│   ├── display.css     /* d-none/d-flex/d-grid */
│   ├── text.css        /* ta-c/ta-l/fw-b/fs-sm */
│   └── visibility.css  /* v-h/v-v/overflow-h */
├── pages/
│   ├── home.css
│   ├── list.css
│   └── detail.css
└── themes/             /* 多主題/品牌定制 */
    ├── dark.css
    └── brand-a.css

工程化落地

  • Stylelint + stylelint-config-bem:CI 中強制命名規範
  • CSS Modules / Styled Components / Tailwind CSS:組件級作用域隔離,物理隔離替代命名隔離
  • Design Tokens:色彩/間距/字體/陰影/動畫參數化,輸出 CSS Variables/JS/JSON,跨平台同步
  • Storybook:組件文檔化、視覺測試、交互演示

好的命名是給未來的自己和隊友寫的文檔。遵循「語義化、模塊化、標準化」,配合現代工程化工具鏈,讓 CSS 從「寫時只懂自己,過後天曉得」進化為「人人可讀、處處可復用、版本可追溯」的資產。

copyright © 萬盛學電腦網 all rights reserved