由於這半年來在學習程式語言，所以想把他們整理成自己的筆記放上來~

常用三種命名方式

  • 駝峰式命名（Camel case）
    • 就像駝峰會一高一低
    • 單字之間不空格，而是直接連起來，但是連起來的第一個字要大寫
    • 例如：有一個 handle add post 的 function，就會叫做 handleAddPost
    • 駝峰式命名還分為：
      • 小駝峰（lower camel case）：開頭是小寫，就像上面的範例 handleAddPost
      • 大駝峰（upper camel case）：又被稱為 Pascal Case。開頭變成大寫，也就會變成HandleAddPost
  • 蛇型命名（Snake case）
    • 蛇就是底線的意思，利用底線來連接單字，然後全部都是小寫
    • 同上述範例，會變成：handle_add_post
  • 烤肉串命名（Kebab case）
    • Kebab 是烤肉串的意思， 符號看起來就像那跟棍子
    • 同上述範例，會變成：handle-add-post

在JavaScript中

在 JavaScript 中，不管是 function 或變數，習慣使用 lower camel case，也就是 handleAddPost在特殊情況下，可以使用大駝峰式，例如：

  • XMLHttpRequest
  • Number
  • Set

這些變數可以算是物件導向中的 class，因此習慣以大寫開頭。而 React 中的 也同樣會使用大寫開頭方式命名。此外，當是常數時，具有不變的特性，通常以 snake case + 全大寫來命名，例如：圓周率 PI，就會是 Math.PI；或是 client id 會寫成 CLIENT_ID。

在資料庫 table 與欄位上

  • 資料庫以 snake case 命名為主
  • table 名稱的慣例是複數，所以使用者資料會叫做 users
  • 欄位名稱同樣是 snake case，以建立時間為例：created_at

Url

snake case 或 kebab case 這兩種慣例都蠻常見的，可能會長這樣：

  • handle_add_post
  • handle-add-post

變數命名條件

  • 大原則：不確定縮寫或簡稱時，就乖乖寫好寫滿。
    • 例如：event handler 傳進來的參數 event，常見的簡寫就是 evt 或是 e。
  • function 通常搭配動詞開頭，get 和 set 就是常見動詞。例如 getGames 或是 getStreams，setName 或是 setTitle。
  • 變數命名開頭不可為數字。 ex. let 3a = 1; 。
  • 變數命名可以接受中文、特殊符號$. _. #等，但盡量不要。
  • 變數命名可以區分大小寫。 ex. let catNum = 1; 和 let catnum = 2; 中，變數catNum和catnum為兩個變數。
  • 變數命名不可使用到保留字(keyword or JavaScript Reserved Words)。

分類於：

軟體工具箱

標籤：

, ,