CSS編寫規範大全

來源:互聯網
上載者:User

一、檔案規格

1、檔案均歸檔至約定的目錄中(具體要求以豆瓣的CSS規範為例進行講解):

所有的CSS分為兩大類:通用類和業務類。通用的CSS檔案,放在如下目錄中:

  • 基本樣式庫 /css/core
  • 通用UI元素樣式庫 /css/lib
  • JS組件相關樣式庫 /css/ui

業務類的CSS是指和具體產品相關的檔案,放在如下目錄中:

  • 讀書 /css/book/
  • 電影 /css/movie/
  • 音樂 /css/music/
  • 社區 /css/sns/
  • 小站 /css/site/
  • 同城 /css/location/
  • 電台 /css/radio/

外聯CSS檔案適用於全站級和產品級通用的大檔案。內聯CSS檔案適用於在一個或幾個頁面共用的CSS。另外一對具體的CSS進行文檔化的整理。如:

  • util-01 reset /css/core/reset.css
  • util-02 通用模組容器 /css/core/mod.css
  • ui-01. 喜歡按鈕 /css/core/fav_btn.css
  • ui-02. 視頻/相簿清單項 /css/core/media_item.css
  • ui-03. 評星 /css/core/rating.css
  • ui-04. 通用按鈕 /css/core/common_button.css
  • ui-05. 分頁 /css/core/pagination.css
  • ui-06. 推薦按鈕 /css/core/rec_btn.css
  • ui-07. 老版對話方塊 /css/core/old_dialog.css
  • ui-08. 老版Tab /css/core/old_tab.css
  • ui-09. 老版成員列表 /css/core/old_userlist.css
  • ui-10. 老版資訊區 /css/core/notify.css
  • ui-11. 社區使用者導航 /css/core/profile_nav.css
  • ui-12. 當前大社區導航 /css/core/site_nav.css
  • ui-13. 載入中 /css/lib/loading.css

2、檔案引入可通過外聯或內聯方式引入

link和style標籤都應該放入head中,原則上,不允許在html上直接寫樣式。避免在CSS中使用@import,嵌套不要超過一層。

  • 外聯方式:<link rel=”stylesheet” href=”…” />(型別宣告type=”text/css”可以省略)
  • 內聯方式:<style>…</style> (型別宣告type=”text/css”可以省略)

3、檔案名稱、檔案編碼及檔案大小

  • 檔案名稱必須由小寫字母、數字、中劃線組成
  • 檔案必須用UTF-8編碼,使用UTF-8(非BOM),在HTML中指定UTF-8編碼,在CSS中則不需要特別指定因為預設就是UTF-8。
  • 單個CSS檔案避免過大(建議少於300行)

二、注釋規範

1、檔案頂部注釋(推薦使用)

Css代碼
  1. /*  
  2. * @description: 中文說明  
  3. * @author: name  
  4. * @update: name (2013-04-13 18:32)  
  5. */  

2、模組注釋

模組注釋必須單獨寫在一行

Css代碼
  1. /* module: module1 by 張三 */  
  2. …  
  3. /* module: module2 by 張三 */  

3、單行注釋與多行注釋

單行注釋可以寫在單獨一行,也可以寫在行尾,注釋中的每一行長度不超過40個漢字,或者80個英文字元。

Css代碼
  1. /* this is a short comment */  

多行注釋必須寫在單獨行內

Css代碼
  1. /*  
  2. * this is comment line 1.  
  3. * this is comment line 2.  
  4. */  

4、特殊注釋

用於標註修改、待辦等資訊

Css代碼
  1. /* TODO: xxxx by name 2013-04-13 18:32 */  
  2. /* BUGFIX: xxxx by name 2012-04-13 18:32 */  

5、區塊注釋

對一個代碼區塊注釋(可選),將樣式語句分區塊並在新行中對其注釋。

Css代碼
  1. /* Header */  
  2. /* Footer */  
  3. /* Gallery */  

三、命名規範

使用有意義的或通用的ID和class命名:ID和class的命名應反映該元素的功能或使用通用名稱,而不要用抽象的晦澀的命名。反映元素的使
用目的是首選;使用通用名稱代表該元素不表特定意義,與其同級元素無異,通常是用於輔助命名;使用功能性或通用的名稱可以更適用於文檔或模版變化的情況。

  • /* 不推薦: 無意義 */ #yee-1901 {}
  • /* 不推薦: 與樣式相關 */ .button-green {}.clear {}
  • /* 推薦: 特殊性 */ #gallery {}#login {}.video {}
  • /* 推薦: 通用性 */ .aux {}.alt {}

常用命名(多記多查英文單詞):page、wrap、layout、header(head)、footer(foot、ft)、
content(cont)、menu、nav、main、submain、sidebar(side)、logo、banner、
title(tit)、popo(pop)、icon、note、btn、txt、iblock、window(win)、tips等。

ID和class命名越簡短越好,只要足夠表達涵義。這樣既有助於理解,也能提高代碼效率。

  • /* 不推薦 */ #navigation {}.atr {}
  • /* 推薦 */ #nav {}.author {}

類型選取器避免同時使用標籤、ID和class作為定位一個元素選取器;從效能上考慮也應盡量減少選取器的層級。

  • /* 不推薦 */ul#example {}div.error {}
  • /* 推薦 */#example {}.error {}

命名時需要注意的點:

  • 規則命名中,一律採用小寫加中劃線的方式,不允許使用大寫字母或 _
  • 命名避免使用中文拼音,應該採用更簡明有語義的英文單詞進行組合
  • 命名注意縮寫,但是不能盲目縮寫,具體請參見常用的CSS命名規則
  • 不允許通過1、2、3等序號進行命名
  • 避免class與id重名
  • id用於標識模組或頁面的某一個父容器地區,名稱必須唯一,不要隨意建立id
  • class用於標識某一個類型的對象,命名必須言簡意賅。
  • 儘可能提高代碼模組的複用,樣式盡量用組合的方式
  • 規則名稱中不應該包含顏色(red/blue)、定位(left/right)等與具體顯示效果相關的資訊。應該用意義命名,而不是樣式顯示結果命名。

1、常用id的命名:

(1) 頁面結構

  • 容器: container
  • 頁頭:header
  • 內容:content/container
  • 頁面主體:main
  • 頁尾:footer
  • 導航:nav
  • 側欄:sidebar
  • 欄目:column
  • 頁面外圍控制整體布局寬度:wrapper
  • 左右中:left right center

(2) 導航

  • 導航:nav
  • 主導航:mainbav
  • 子導航:subnav
  • 頂導航:topnav
  • 邊導航:sidebar
  • 左導航:leftsidebar
  • 右導航:rightsidebar
  • 菜單:menu
  • 子功能表:submenu
  • 標題: title
  • 摘要: summary

(3) 功能

  • 標誌:logo
  • 廣告:banner
  • 登陸:login
  • 登入條:loginbar
  • 註冊:regsiter
  • 搜尋:search
  • 功能區:shop
  • 標題:title
  • 加入:joinus
  • 狀態:status
  • 按鈕:btn
  • 滾動:scroll
  • 標籤頁:tab
  • 文章列表:list
  • 提示資訊:msg
  • 當前的: current
  • 小技巧:tips
  • 表徵圖: icon
  • 注釋:note
  • 指南:guild
  • 服務:service
  • 熱點:hot
  • 新聞:news
  • 下載:download
  • 投票:vote
  • 夥伴:partner
  • 友情連結:link
  • 著作權:copyright

2、常用class的命名:

(1) 顏色:使用顏色的名稱或者16進位代碼,如

  • .red { color: red; }
  • .f60 { color: #f60; }
  • .ff8600 { color: #ff8600; }

(2) 字型大小,直接使用”font+字型大小”作為名稱,如

  • .font12px { font-size: 12px; }
  • .font9pt {font-size: 9pt; }

(3) 對齊樣式,使用對齊目標的英文名稱,如

  • .left { float:left; }
  • .bottom { float:bottom; }

(4) 標題列樣式,使用”類別+功能”的方式命名,如

  • .barnews { }
  • .barproduct { }

四、書寫規範

1、排版規範

(1) 使用4個空格,而不使用tab或者混用空格+tab作為縮排;

(2) 規則可以寫成單行,或者多行,但是整個檔案內的規則排版必須統一;

單行形式書寫風格的排版約束:

  • 如果是在html中寫內聯的css,則必須寫成單行;
  • 每一條規則的大括弧 { 前後加空格 ;
  • 每一條規則結束的大括弧 } 前加空格;
  • 屬性名稱冒號之前不加空格,冒號之後加空格;
  • 每一個屬性值後必須添加分號; 並且分號後空格;
  • 多個selector共用一個樣式集,則多個selector必須寫成多行形式 ;

多行形式書寫風格的排版約束:

  • 每一條規則的大括弧 { 前添加空格;
  • 多個selector共用一個樣式集,則多個selector必須寫成多行形式;
  • 每一條規則結束的大括弧 } 必須與規則選取器的第一個字元對齊;
  • 屬性名稱冒號之前不加空格,冒號之後加空格;
  • 屬性值之後添加分號;

2、屬性編寫順序

  • 顯示內容:display/list-style/position/float/clear …
  • 自身屬性(盒模型):width/height/margin/padding/border
  • 背景:background
  • 行高:line-height
  • 文字屬性:color/font/text-decoration/text-align/text-indent/vertical-align/white-space/content…
  • 其他:cursor/z-index/zoom/overflow
  • CSS3屬性:transform/transition/animation/box-shadow/border-radius
  • 如果使用CSS3的屬性,如果有必要加入瀏覽器首碼,則按照 -webkit- / -moz- / -ms- / -o- / std的順序進行添加,標準屬性寫在最後。
  • 連結的樣式請嚴格按照如下順序添加: a:link -> a:visited -> a:hover -> a:active

3、規則書寫規範

  • 使用單引號,不允許使用雙引號;
  • 每個聲明結束都應該帶一個分號,不管是不是最後一個聲明;
  • 除16進位顏色和字型設定外,CSS檔案中的所有的代碼都應該小寫;
  • 除了重設瀏覽器預設樣式外,禁止直接為html tag添加css樣式設定;
  • 每一條規則應該確保選取器唯一,禁止直接為全域.nav/.header/.body等類設定屬性;

4、代碼效能最佳化

  • 合并margin、padding、border的-left/-top/-right/-bottom的設定,盡量使用簡短名稱。
  • 選取器應該在滿足功能的基礎上盡量簡短,減少選取器嵌套,查詢消耗。但是一定要避免覆蓋全域樣式設定。
  • 注意選取器的效能,不要使用低效能的選取器。
  • 禁止在css中使用*選擇符。
  • 除非必須,否則,一般有class或id的,不需要再寫上元素對應的tag。
  • 0後面不需要單位,比如0px可以省略成0,0.8px可以省略成.8px。
  • 如果是16進位表示顏色,則顏色取值應該大寫。
  • 如果可以,顏色盡量用三位字元表示,例如#AABBCC寫成#ABC 。
  • 如果沒有邊框時,不要寫成border:0,應該寫成border:none 。
  • 盡量避免使用AlphaImageLoader 。
  • 在保持代碼解耦的前提下,盡量合并重複的樣式。
  • background、font等可以縮寫的屬性,盡量使用縮寫形式 。

5、CSS Hack的使用

請不用動不動就使用瀏覽器檢測和CSS Hacks,先試試別的解決方案吧!考慮到代碼高效率和易管理,雖然這兩種方法能快速解決瀏覽器解析差異,但應被視為最後的手段。在長期的項目中,允許使用hack只會帶來更多的hack,你越是使用它,你越是會依賴它!

推薦使用下面的:

6、字型規則

  • 為了防止檔案合并及編碼轉換時造成問題,建議將樣式中文字型名字改成對應的英文名字,如:黑體(SimHei) 宋體(SimSun) 微軟雅黑 (Microsoft Yahei,幾個單詞中間有空格組成的必須加引號)
  • 字型粗細採用具體數值,粗體bold寫為700,正常normal寫為400
  • font-size必須以px或pt為單位,推薦用px(註:pt為列印版字型大小設定),不允許使用xx-small/x-small/small/medium/large/x-large/xx-large等值
  • 為了對font-family取值進行統一,更好的支援各個作業系統上各個瀏覽器的相容性,font-family不允許在業務代碼中隨意設定

五、測試規範

1、瞭解瀏覽器特效支援

為了頁面效能考慮,如果瀏覽器不支援CSS3相關屬性的,則該瀏覽器的某些特效將不再支援,屬性的支援情況如下表所示(Y為支援,N為不支援):

2、 設定瀏覽器支援標準

  • A級-互動和視覺完全符全設計的要求
  • B級-視覺上允許有所差異,但不破壞頁面的整體效果
  • C級-可忽略設計上的細節,但不防礙使用

3、常用樣式測試載入器

  • W3C CSS validator:http://jigsaw.w3.org/css-validator/
  • CSS Lint:http://csslint.net/
  • CSS Usage:https://addons.mozilla.org/en-us/firefox/addon/css-usage/

六、其他規範

    • 不要輕易改動全站級CSS和通用CSS庫。改動後,要經過全面測試。
    • 避免使用filter
    • 避免在CSS中使用expression
    • 避免過小的背景圖片平鋪。
    • 盡量不要在CSS中使用!important
    • 絕對不要在CSS中使用”*”選擇符
    • 層級(z-index)必須清晰明確,頁面彈窗、氣泡為最進階(最進階為999),不同彈窗氣泡之間可在三位元之間調整;普通區塊為10-90內10的倍數;區塊展開、彈出為當前父層級上個位增加,禁止層級間盲目攀比。
    • 背景圖片請儘可能使用sprite技術, 減小http請求, 考慮到多人協作開發, sprite按照模組、業務、頁面來劃分均可。
相關文章

Alibaba Cloud 10 Year Anniversary

With You, We are Shaping a Digital World, 2009-2019

Learn more >

Apsara Conference 2019

The Rise of Data Intelligence, September 25th - 27th, Hangzhou, China

Learn more >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。