一個專案做完,很多人隔沒多久就忘了它的結構與細節。但程式碼往往不會就此定版,後續維護可能還交到了別人手上。因此結構清晰的樣式表,很大程度上決定了它的可維護性。以下 five 個做法可以參考。
小專案的做法是在檔案內用註解分區,例如全域樣式、佈局、字型、表單、留言、其他,各自成塊。
大型專案則應該拆成多個檔案,用一個主樣式表統一匯入。這麼做不僅讓結構清楚,也能減少不必要的請求:
/*------------------------------------------------------------------ [Master Stylesheet] Project: Smashing Magazine Version: 1.1 Last change: 05/02/08 [fixed Float bug, vf] Assigned to: Vitaly Friedman (vf), Sven Lennartz (sl) Primary use: Magazine -------------------------------------------------------------------*/ @import "reset.css"; @import "layout.css"; @import "colors.css"; @import "typography.css"; @import "flash.css"; /* @import "debugging.css"; */
主樣式表的檔頭把專案名稱、版本、最後修改日期、負責人與用途都列出來,這幾行資訊在多人協作時價值極高。大型專案還可以加上升版標記或診斷用的樣式(平時註解掉、除錯時再啟用)。
在檔案開頭放一份目錄,讓人不必搜尋就能掌握整體結構。第一種是樹狀寫法,用縮排表達從屬關係:
/*------------------------------------------------------------------
[Layout]
* body
+ Header / #header
+ Content / #content
- Left column / #leftcolumn
- Right column / #rightcolumn
- Sidebar / #sidebar
- RSS / #rss
- Search / #search
- Boxes / .box
+ Footer / #footer
Navigation #navbar
Advertisements .ads
Content header h2
-------------------------------------------------------------------*/
第二種是編號式目錄,層級用 2.1、3.3.1 這樣的數字表示:
/*------------------------------------------------------------------
[Table of 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
4. Footer / #footer
-------------------------------------------------------------------*/
第三種最精簡,只把區塊平鋪列出、不做縮排:
/*------------------------------------------------------------------ [Table of contents] 1. Body 2. Header / #header 3. Navigation / #navbar 4. Content / #content 5. Sidebar / #sidebar 6. RSS / #rss 7. Search / #search 8. Boxes / .box 9. Footer / #footer -------------------------------------------------------------------*/
搭配的做法是在每個區塊的註解裡重複相同的標題,讓搜尋成為可行的跳轉方式。例如需要跳到 RSS 段落,只要搜尋「6. RSS」:
<!-- some CSS-code -->
/*------------------------------------------------------------------
[6. RSS / #rss]
-------------------------------------------------------------------*/
#rss { ... }
#rss img { ... }
一份好的索引能讓接手的人快速理解你的思路,也能在自己回頭修改時省去重新摸索的成本。做大型專案時,把目錄印出來貼在座位旁,翻閱效率還會再高一層。
其餘三個做法可以搭配使用:命名保持一致(decision 一次做完,別讓 margin-top 與 mt 混用)、屬性排列順序固定(例如一律從定位寫到 box model 再到文字)、以及把除錯用的暫時樣式集中管理,方便最後一次清乾淨。