成熟的 CSS 專案離不開結構化的註釋策略。以下三種進階用法能大幅提升代碼可維護性:
避免過度修飾(如 ul.nav)會提升效能與複用性,但開發者可能想知道類別預期用於何種元素。解法:將類型選擇器註釋化:
/*html*/.product-page { } /* 預期用於 html 或 body */
/*ol*/.breadcrumb { } /* 預期用於 ol */
/*p*/.intro { } /* 預期用於 p */
瀏覽器忽略註釋,優先級不變;人類閱讀即獲知預期語境。
在模組頂部加入標籤註釋,採用 ^keyword 格式:
/**
* ^navigation ^lists
*/
.nav { }
/**
* ^grids ^lists ^tables
*/
.matrix { }
搜尋 ^lists 即可一次定位所有列表相關模組,極大加速跨檔案導航。
採用 OOCSS 時,基礎樣式與主題擴充常分處不同檔案。雙向註釋建立關聯:
/* base.css */
.foo {
/** @extend .foo in theme.css */
}
/* theme.css */
.bar {
/** @extends .foo in base.css */
}
工具(如 Stylelint、PostCSS plugins)可解析此類註釋自動檢測斷鏈或生成文檔。
將這些慣例寫入團隊風格指南,配合編輯器 Snippets 快速插入,讓註釋成為生產力工具而非負擔。