在這裡發表的大多數文章中,我們並未特別著墨於 CSS 檔的可讀性與可維護性。而現實是:一項前端工作完成後,很多人很快就忘了這個專案的結構與細節。更何況程式碼往往不會立刻定案,後續還有不斷的維護,而這些維護工作未必是你自己做的。
所以,結構良好的程式碼,很大程度上決定了它好不好維護。下面四則技巧,可以作為建立良好 CSS 組織習慣的起點。
對小專案來說,寫程式碼之前先按頁面結構或內容把樣式分成幾塊並加上註解,就夠了。例如把全域樣式、版面、字體、表單、評論、其他分成幾個區塊分別推進。
但對大型專案,這招顯然效果有限。此時需要把樣式拆到幾個不同的樣式表檔裡。下面的 master stylesheet 就是這個思路的示例,它主要負責引入其他樣式檔。這麼做不僅讓結構更清楚,也有助於減少不必要的伺服器請求。拆分的方法有很多種,這裡用的是最常見的一種。
@import "reset.css"; @import "layout.css"; @import "colors.css"; @import "typography.css"; @import "flash.css"; /* @import "debugging.css"; */
大型專案還可以加上版本標記或診斷措施,這裡不展開。重點是在日常實作中持續總結與思考。
為了快速掌握整個檔案的結構,在開頭建立一份索引是很划算的投資。一種可行做法是樹狀索引,結構上的 id 與 class 都能成為樹的一個分支:
[Layout] * body + Header / #header + Content / #content - Left column / #leftcolumn - Right column / #rightcolumn - Sidebar / #sidebar - RSS / #rss - Search / #search - Boxes / .box - Sideblog / #sideblog + Footer / #footer Navigation #navbar Advertisements .ads Content header h2
或者用編號式的目錄:
[Contents] 1. Body 2. Header / #header 2.1. Navigation / #navbar 3. Content / #content 3.1. Left column / #leftcolumn 3.2. Right column / #rightcolumn 3.3. Sidebar / #sidebar 3.3.1. RSS / #rss 3.3.2. Search / #search 3.3.3. Boxes / .box 3.3.4. Sideblog / #sideblog 3.3.5. Advertisements / .ads 4. Footer / #footer
也可以最樸素地條列,不做縮排。這樣若要跳到 RSS 那一段,直接搜尋即可。
[Contents]
1. Body
2. Header / #header
...
13. Footer / #footer
/*--[8. RSS / #rss]--*/
#rss { ... }
#rss img { ... }
這樣一份檢索,能讓其他人讀懂你的程式碼變得容易得多。做大型專案時,你甚至可以把它印出來,讀程式碼時方便對照。
編寫時採用某種固定的風格,對可讀性幫助很大。每個人習慣不同:有人把顏色與字體相關的宣告放在前面,有人偏好把浮動、定位這類更「關鍵」的屬性放前面。也可以按元素在版面中的結構順序排列:
body,
h1, h2, h3,
p, ul, li,
form {
margin: 0;
padding: 0;
border: 0;
}
也有開發者把屬性按字母順序排列。值得注意的是,這麼做在某些瀏覽器上可能出問題。無論你選哪種格式,重點是把它明確定義下來並貫徹——這樣你的同事讀你的程式碼時,會感謝你的努力。
為了讓程式碼更直觀,你可以用一行來定義輪廓元素的樣式。當某個選擇器下的屬性超過三個時,這種寫法就會變得混亂;但適度使用,你能清楚區分同一類元素之間的差異。
#main-column { display: inline; float: left; width: 300px; }
#main-column h1 { margin-bottom: 20px; }
#main-column p { color: #333; }
樣式的修改與維護也常是個燙手山芋。很多人改完樣式就忘了,後來頁面出錯,又得回頭苦苦尋找。因此替修改過的樣式建立一套標記格式很有必要。一個簡單做法是:把改動過的宣告縮排,並加上註解標記(例如 "@new")。
#sidebar ul li a {
display: block;
background-color: #ccc;
border-bottom: 1px solid #999; /* @new */
margin: 3px 0 3px 0;
padding: 3px; /* @new */
}
總的來說,只有建立一套合適的樣式指南,才真正有助於樣式表的可讀性。記得移除每一條對理解檔案毫無幫助的「指南」,避免為過多元素套用過多規則。然後,朝著一個可讀、可維護的 CSS 檔前進吧。