程式碼書寫規範

大喻喻發表於2018-01-18

以前自己學習前端,根本沒有程式碼規範,今天被帶我的老大痛批一頓?,惡補一堆,review以前寫的程式碼,慘不忍睹。來一篇關於程式碼書寫規範的總結,以後會陸續補充,也歡迎小夥伴們評論補充。

CSS書寫規範

1 書寫順序  

  1. 位置屬性(position, top, right, z-index,display, float等)  
  2. 大小(width, height, padding, margin)  
  3. 文字系列(font, line-height, letter-spacing,color- text-align等)  
  4. 背景(background, border等)  
  5. 其他(animation, transition等)

2 使用CSS縮寫屬性

  1. CSS有些屬性是可以縮寫的,比如padding,margin,font等等,這樣精簡程式碼同時又能提高使用者的閱讀體驗。但是!不能處處都是縮寫,比如:background
  2. 去掉小數點前的“0”
  3. 16進位制顏色程式碼縮寫
  4. 連字元CSS選擇器命名規範,長名稱或片語可以使用中橫線來為選擇器命名。不建議使用“”下劃線來命名CSS選擇器,為什麼呢?輸入的時候少按一個shift鍵;瀏覽器相容問題 (比如使用_tips的選擇器命名,在IE6是無效的),能良好區分JavaScript變數命名(JS變數命名是用“”)
  5. 不要隨意使用Id,id在JS是唯一的,不能多次使用,而使用class類選擇器卻可以重複使用,另外id的優先順序優先與class,所以id應該按需使用,而不能濫用。
  6. 為選擇器新增狀態字首,有時候可以給選擇器新增一個表示狀態的字首,讓語義更明瞭,比如下圖是新增了“.is-”字首。

CSS命名規範(規則)常用的CSS命名規則  

頭:header 內容:content/container 尾:footer   導航:nav   側欄:sidebar   欄目:column   頁面外圍控制整體佈局寬度:wrapper   左右中:left right center   登入條:loginbar   標誌:logo   廣告:banner  頁面主體:main   熱點:hot   新聞:news   下載:download   子導航:subnav   選單:menu   子選單:submenu   搜尋:search   友情連結:friendlink   頁尾:footer  版權:copyright   滾動:scroll   內容:content   標籤:tags   文章列表:list   提示資訊:msg   小技巧:tips   欄目標題:title   加入:joinus   指南:guide   服務:service   註冊:regsiter   狀態:status   投票:vote   合作伙伴:partner

註釋的寫法 

/* Header /  內容區  / End Header */

Id的命名  

1)頁面結構  

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

2)導航  

導航:nav   主導航:mainnav  子導航:subnav   頂導航:topnav   邊導航:sidebar   左導航:leftsidebar   右導航:rightsidebar   選單:menu   子選單:submenu   標題: title   摘要: summary

3)功能  

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

注意事項  

1.一律小寫;   2.儘量用英文;   3.不加中槓和下劃線;   4.儘量不縮寫,除非一看就明白的單詞。

CSS樣式表檔案命名  

主要的 master.css   模組 module.css   基本共用 base.css   佈局、版面 layout.css   主題 themes.css   專欄 columns.css   文字 font.css   表單 forms.css   補丁 mend.css   列印 print.css

參考連結:https://www.zhihu.com/question/19586885/answer/48933504
來源:知乎
複製程式碼

相關文章