參考:Smashing Magazine 翻譯整理:Demix
完成一項前端工作後,很多人很快就忘記了當初的項目結構與細節。然而代碼往往不會一次定稿,後續還有漫長的維護期,而接手的人未必是你自己。因此,結構良好的代碼能極大提升可維護性。以下五種方法,就是一份不錯的 CSS 樣式指南。
1. 分解你的樣式
對於小項目,在動手寫代碼前,可按頁面結構或內容把代碼分成幾塊並加上注釋。例如把全局樣式、布局、字體、表單、評論等各自歸為獨立的區塊。
而對於較大的工程,這種做法效果有限。此時就需要把樣式拆分到多個樣式表文件中。下面的 master stylesheet 就是典型例子,它主要負責導入其他樣式文件。這樣做不僅優化結構,還有助於減少不必要的服務器請求。拆分文件的方式有很多種,這裡採用的是最常見的一種。
/*------------------------------------------------------------------
[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"; */
對於大型項目,你還可以加上 CSS 文件的版本標志或診斷措施,這裡不再詳述。
2. 建立 CSS 文件索引
為了快速掌握整個 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
——————————————————————-*/
或者採用帶編號的目錄形式:
/*------------------------------------------------------------------
[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
3.3.4. Sideblog / #sideblog
3.3.5. Advertisements / .ads
4. Footer / #footer
-------------------------------------------------------------------*/
還有一種更簡單的方式,只需把內容平鋪列舉、無需縮進。比如下面這個例子,若想跳到 RSS 部分,只要搜索 8.RSS 即可。
/*------------------------------------------------------------------
[Table of contents]
1. Body
2. Header / #header
3. Navigation / #navbar
4. Content / #content
5. Left column / #leftcolumn
6. Right column / #rightcolumn
7. Sidebar / #sidebar
8. RSS / #rss
9. Search / #search
10. Boxes / .box
11. Sideblog / #sideblog
12. Advertisements / .ads
13. Footer / #footer
-------------------------------------------------------------------*/
<!-- some CSS-code -->
/*------------------------------------------------------------------
[8. RSS / #rss]
*/
#rss { ... }
#rss img { ... }
建立這樣一份檢索,能讓他人更容易閱讀和學習你的代碼。製作大項目時,你還可以把索引打印出來,方便隨時查閱。
3. 定義你的顏色與版式
CSS 中無法使用常量,但在編寫顏色和版式時,我們經常會反覆用到同一組值,這裡可以把它們視為 CSS 的「常量」。一種減少混亂的做法,是在文件頂部的注釋中集中定義它們。最簡單的應用就是建立一張顏色表,這樣既能快速掌握整站的配色,也能避免反覆修改時出錯;需要調整顏色時,也能迅速定位。
/*------------------------------------------------------------------
# [Color codes]
# Dark grey (text): #333333
# Dark Blue (headings, links) #000066
# Mid Blue (header) #333399
# Light blue (top navigation) #CCCCFF
# Mid grey: #666666
# */
或者,你也可以按布局用途來描述顏色,把用到同一顏色的塊列出來,也可以按頁面元素來歸類。
/*------------------------------------------------------------------
[Color codes]
Background: #ffffff (white)
Content: #1e1e1e (light black)
Header h1: #9caa3b (green)
Header h2: #ee4117 (red)
Footer: #b5cede (dark black)
a (standard): #0040b6 (dark blue)
a (visited): #5999de (light blue)
a (active): #cc0000 (pink)
-------------------------------------------------------------------*/
版式也有類似的做法。
/*------------------------------------------------------------------
[Typography]
Body copy: 1.2em/1.6em Verdana, Helvetica, Arial, Geneva, sans-serif;
Headers: 2.7em/1.3em Helvetica, Arial, "Lucida Sans Unicode", Verdana, sans-serif;
Input, textarea: 1.1em Helvetica, Verdana, Geneva, Arial, sans-serif;
Sidebar heading: 1.5em Helvetica, Trebuchet MS, Arial, sans-serif;
Notes: 每下降一級標題層級,字號遞減 0.4em
-------------------------------------------------------------------*/
4. 格式化 CSS 屬性
編寫代碼時,養成特定的編碼風格能大幅提升可讀性。每個人都有自己的習慣:有人喜歡把顏色和字體寫在前面,有人則偏好把浮動、定位這些「更重要」的屬性放在前面。也可以按元素在布局中的結構順序排列:
body,
h1, h2, h3,
p, ul, li,
form {
border: 0;
margin: 0;
padding: 0;
}
有些開發者則採用更有趣的方式:按屬名字母順序排列。值得注意的是,這種做法在某些瀏覽器上可能引發問題。
無論採用哪種格式,關鍵是要清晰定義並貫徹它。這樣,你的同事在閱讀你的代碼時,一定會感謝你的用心。
5. 縮進會是你的朋友!
為了讓代碼更直觀,可以用一行來定義外層元素的樣式。當某個選擇器的屬性超過三個時,這種寫法容易變得混亂;但只要用得克制,你就能清楚區分同類元素之間的差異。
#main-column { display: inline; float: left; width: 30em; }
#main-column h1 { font-family: Georgia, "Times New Roman", Times, serif; 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 文件而不懈努力吧。