2019年3月20日 星期三

[Back To Basic] Javascript - 風格指南(style guide)

目的為確保程式的品質

  • 可讀性
  • 可維護性

變數名稱

  • 使用小駝峰命名法(camelCase)
  • 所有變數以字母(letter)開頭

操作符號(operators)和逗號(comma)

  • 操作符號左右空一格
  • 逗號後方空一格

縮排(Identation)

  • 在區塊(block)中使用二個空格縮排

簡單Statement規則

  • 一個陳述結束要用分號(;)結尾

區塊Statement規則

  • 開頭括號在第一行結尾後方
  • 開頭括號前給一個空格
  • 結尾括號放在新的一行, 後方不要有空白
  • 結尾括號後面不用加上分號

物件(Object)規則

  • 開頭括號在第一行結尾後方
  • 屬性名稱和值中間加上冒號和一個空白
  • 屬性值若是字串加上引號在兩旁, 若是數值則不要加
  • 最後一個屬性值組合後面不要加上逗號
  • 結尾括號放在新的一行, 後方不要有空白
  • 結尾括號後面要加上分號, 作為物件定義的結束

單一行程式碼長度

  • 不要超過80個字元

載入外部 script 時不要加入 type 宣告

副檔名用 .html 不要用 .htm

檔名都用小寫,因為有些伺服器會將大小寫視為不同檔案

小的 script檔案以可讀性為目標,大的 script 檔案以壓縮到最小為目標

沒有留言:

張貼留言