注釋在 CSS 裡的重要性常被低估。它能提醒你這段規則的用意、對應 HTML 裡的哪個位置,也能在多人協作時充当溝通媒介。本文除了基本語法,還談幾個讓注釋真正發揮價值的進階用法。
CSS 注釋以 /* 開始、*/ 結束,不像 HTML 那樣支援巢狀。
/* ---------- 文字樣式開始 ---------- */
/* 白色 12 像素文字 */
.white12px {
color: white;
font-size: 12px;
}
/* 黑色 16 像素文字 */
.black16px {
color: black;
font-size: 16px;
}
/* ---------- 文字樣式結束 ---------- */
較成熟的團隊會採用 docBlock 風格,把行寬控制在 80 字元以內,並允許在注釋中嵌入 HTML 標記:
/**
* This is a docBlock style comment
*
* This is a longer description of the comment, describing the code in more
* detail. We limit these lines to a maximum of 80 characters in length.
*
* We can have markup in the comments, and are encouraged to do so:
*
* <div class=foo>
* <p>Lorem</p>
* </div>
*
* We do not prefix lines of code with an asterisk as to do so would inhibit
* copy and paste.
*/
/**
* 這是一個文檔塊(DocBlock)風格的注釋。
*
* 這裡開始是描述更詳細、篇幅更長的注釋正文。當然,我們要把行寬控制在 80 字元以內。
*
* 我們可以在注釋中嵌入 HTML 標記,而且這也是個不錯的辦法:
*
* <div class=foo>
* <p>Lorem</p>
* </div>
*
* 如果是注釋內嵌的標記,在它前面不加星號,以免被複製進去。
*/
核心原則是:對你而言顯而易見的東西,對其他人未必如此。每寫完一段關鍵邏輯,就該補一段注釋說明「為什麼」這樣做。
過度修飾選擇器會拖累效能、妨礙 class 復用,並讓選擇器變得專用而難以共享。所以能寫 .nav{} 就不要寫 ul.nav{}。
但有時你確實想告訴同事某個 class 的預期使用範圍。以 .product-page 為例,它看起來像根容器,可能掛在 html 或 body 上,光看名字卻無法確定。這時可以把類型選擇器「注釋掉」,形成準修飾:
/*html*/.product-page{}
這樣既說明了作用範圍,又不影響 class 的復用性。其他例子:
/*ol*/.breadcrumb{}
/*p*/.intro{}
/*ul*/.image-thumbs{}
寫完一組新樣式後,在它上方加個標籤,例如 /* =Lists */ 或 ^lists。這讓其他開發者搜尋關鍵字就能快速定位——想找列表相關的樣式,搜 ^lists 就能一次跳到所有相關區塊。標籤命名保持一致,效果才好。
用物件導向的思路寫 CSS 時,常會出現兩段密切相關(一段是基礎、一段是擴展)卻分散在檔案兩端的規則。繼承標記就是在兩者之間建立明確關聯。
在基礎樣式處:
/**
* Extend `.foo` in theme.css
*/
.foo{}
在擴展樣式處:
/**
* Extends `.foo` in base.css
*/
.bar{}
如此一來,即使兩段程式碼相隔數百行,讀者也能立刻知道它們的關係,不必靠記憶或全文搜尋。