當完成一項前端的工作之後,許多人都會忘記該項目的結構與細節。然而代碼並不是馬上就能完全定型,在餘下的時間里還有不斷的維護工作,而這些工作也許不會是你自己完成。所以,結構優良的代碼能很大程度上優化它的可維護性。下麵列出五種提高CSS文件可維護性的方法,也就是一種較好的CSS樣式指南。1.分解你的樣式對
當完成一項前端的工作之後,許多人都會忘記該項目的結構與細節。然而代碼並不是馬上就能完全定型,在餘下的時間里還有不斷的維護工作,而這些工作也許不會是你自己完成。所以,結構優良的代碼能很大程度上優化它的可維護性。下麵列出五種提高CSS文件可維護性的方法,也就是一種較好的CSS樣式指南。
1.分解你的樣式
對於小項目,在寫代碼之前,按頁面結構或頁面內容將代碼分為幾塊並給予註釋。例如,可以分別將 全局樣式、佈局、字體樣式、表單、評論和其他分為幾個不同的塊來繼續工作。
而對於較大的工程,這樣顯然不會有什麼效果。此時,就需要將樣式分解到幾個不同的樣式表文件。下麵的master stylesheet 就是這一方法的例子,它的工作主要是導入其他樣式文件。使用這一方法不僅能優化樣式結構,而且有利於減少一些不必要的伺服器請求。而分解文件的方法就有許多種,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
3.定義你的顏色和版式
CSS 中我們無法使用常量,但是在編寫顏色和版式方面的代碼是我們會經常遇到可以使用很多次的類,在這裡可以將之視為CSS 的常量。
一種可以減小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: decreasing heading by 0.4em with every subsequent heading level
-------------------------------------------------------------------*/
4.格式化CSS屬性
當我們編寫代碼的時候,使用一些特殊的編碼風格會對提高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文件而努力吧。
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 { ... }
定義這樣一個樣式檢索可以很有效的使其他人閱讀學習你的代碼變得容易。在製作大項目的時候,你也可以將檢索列印出來從而在你閱讀代碼的時候方便查閱。