CSS 無原生模組化機制,隨專案增大,樣式表易變得難以維護。善用註釋可傳達設計意圖、標示模組邊界、建立可搜尋的標記系統,大幅提升團隊協作效率。
避免過度限定選擇器(如 ul.nav),但仍想告知開發者「此 class 應用於何種元素」。解法:將類型選擇器註釋化。
/*html*/.product-page { } /* 根容器,通常掛在 html 或 body */
/*ol*/.breadcrumb { } /* 應用於 ol 元素 */
/*p*/.intro { } /* 應用於 p 元素 */
/*ul*/.image-thumbs { } /* 應用於 ul 元素 */
優點:不影響實際選擇器權重、不限制復用性、可搜尋。
在相關樣式群組上方加上可搜尋的標籤(以 ^ 開頭),支援跨檔案跳轉。
/**
* ^navigation ^lists
*/
.nav { }
/**
* ^grids ^lists ^tables
*/
.matrix { }
使用場景:開發者搜尋 ^lists 即可找到所有列表相關樣式(.nav、.matrix 等)。
面向對象 CSS(OOCSS)中,基礎樣式與擴充樣式常分離。用註釋建立雙向連結:
/* 基礎樣式 base.css */
/**
* Extend `.foo` in theme.css
*/
.foo { }
/* 擴充樣式 theme.css */
/**
* Extends `.foo` in base.css
*/
.bar { }
優點:閱讀任一檔案即可知曉關聯檔案,減少跳轉成本。
/**
* ^layout ^header ^navigation
* Extends `.site-header` in _base-header.css
*/
.site-header--home {
/* ... */
}
/* _base-header.css */
/**
* ^layout ^header
* Extend `.site-header--home` in _home-header.css
*/
.site-header {
/* ... */
}
/** ... */ 區塊註釋用於區塊說明,// 單行註釋用於行內說明(需預處理器支援)。^ 代表模組標籤,@ 代表 TODO/FIXME,> 代表繼承關係。CSS 註釋不只是「說明」,更是架構文檔。準修飾選擇器保留語意不犧牲彈性;代碼標籤構建可搜尋知識圖譜;繼承標記串聯分散的樣式關係。三大技巧結合,讓大型 CSS 代碼庫保持可讀、可維護、可擴展。