前端開發項目開發規約

文件命名規約

• 項目名稱
  小寫，如下劃線分隔
• 目錄命名
  小寫，多文件使用複數
• JS文件命名
  同項目名稱同
• CSS, SCSS文件命名
  同項目名
• HTML文件命名
  同項目名

HTML代碼規約

1. 語法

• 縮進，4空格
• 嵌套的節點加縮進
• 屬性使用雙引號
• 屬性名小寫，用中劃線分隔
• 注意標籤關閉

1. 一些規約

• 屬性順序

class
id
name
data-*
src, for, type, href, value , max-length, max, min, pattern
placeholder, title, alt
aria-*, role
required, readonly, disabled

• 少用js生成標籤
• 減小標籤數量

CSS, SCSS

• 縮進，4空格
• 結尾加分號
• 文件結尾加空行
• 顏色,16進制小寫字母

JavaScript

• 縮進,4空格
• 單行長度不超過80個字符

• 分號使用

  • 變量聲明
  • 表達式
  • return
  • throw
  • break
  • continue
  • do-while

• 空格使用
  不加空格

  • 對象的屬性名後
  • 前綴一元運算符後
  • 後綴一元運算符前
  • 函數調用括號前
  • 數組的'['後和']'前
  • 對象的'{'後和'}'前
  • 運算符'('後和')'前
  • 函數聲明或函數表達式，'('前不要空格

• 空行

  • 變量聲明後（當變量聲明在代碼塊的最後一行時，則無需空行）
  • 註釋前（當註釋在代碼塊的第一行時，則無需空行）
  • 代碼塊後（在函數調用、數組、對象中則無需空行）
  • 文件最後保留一個空行
• 引號，最外層使用單引號

• 變量命名

  • 標準變量採用駝峯式命名（除了對象的屬性外，主要是考慮到cgi返回的數據）
  • 'ID'在變量名中全大寫
  • 'URL'在變量名中全大寫
  • 'Android'在變量名中大寫第一個字母
  • 'iOS'在變量名中小寫第一個，大寫後兩個字母
  • 常量全大寫，用下劃線鏈接
  • 構造函數，大寫第一個字母
  • jquery對象必須以'$'開頭命名