Javascript 命名規範

發表於 更新於 分類於

在Javascript語法裡面
變數與常數命名方式要特別留意

不是所有的字都可以當作變數與常數的名稱，各位可以參考以下命名規則以及慣例

  • 駝峰式命名方式Camel Case，譬如calculateTotalAmount、userName、lastName、getProductInfo、calculateTax，命名的一致性對於團隊合作的時候非常有幫助，也是JS的命名慣例。

  • 不可以使用Javascript保留字，因為這群保留字在javscript具有特殊的語法和意義，詳細資料請看最底下的保留字列表。

  • 不可以使用數字作為開頭。會造成程式碼的錯誤結果，假如有一個”123var”或是”6variable”的變數，這樣是錯的，會引發SyntaxError或是程式碼錯誤。

  • 可以使用下底線作為開頭
    _privateVariable、
    _userProfileData、
    _calculateTotalAmount、
    _getProductInfoById，但是不同專案的狀況，還是要依據該專案的命名風格為主，以確保整個程式碼的一致性

  • 建議使用有意義的名稱，讓其他人一眼看到可以大概了解是什麼意思，在閱讀程式碼的時候，或是在維護程式的時候，可以更快更容易理解。

  • 避免使用縮寫，譬如:tAmt、dBase、Ncount，這樣無法釐清真實的意義，非常混淆

  • 名稱是區分大小寫的，大寫字母和小寫字母是不一樣的名稱，譬如:userAge 和 UserAge是不同的變數，它們具有不同的意義，但是請使用駝峰式命名 (Camel Case)為主

保留字列表
1.break
2.case
3.catch
4.class
5.const
6.continue
7.debugger
8.default
9.delete
10.do
11.else
12.export
13.extends
14.false
15.finally
16.for
17.function
18.if
19.import
20.in
21.instanceof
22.new
23.null
24.return
25.super
26.switch
27.this
28.throw
29.true
30.try
31.typeof
32.var
33.void
34.while
35.with

請參考mdn說明
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#keywords