實體檔案

檔案命名盡量以Snake case為主，採用26個英文字母(全小寫)和0-9的自然數、下底線組成，多個單字用下底線分隔。

---

程式內

function與變數

程式內的function名稱與變數名稱以Camel case為主，採用26個英文字母和0-9的自然數組成。
除非長度過長，否則盡量以能理解的方式進行命名。

如果變數或function的存在區域只限於某個function裡(或是Class的private屬性、method)，可以使用下底線開頭當作識別。

---

資料庫

資料庫名稱

Snake case，採用26個英文字母(全小寫)和0-9的自然數、下底線組成，多個單字用下底線分隔。

資料表(table、collection)名稱

Snake case，採用26個英文字母(全小寫)和0-9的自然數、下底線組成，多個單字用下底線分隔。

• 禁止只使用關鍵字當作命名。如：name、password、date、time.
• 命名以不超過三個單字為主。
• 資料表以複數命名，例如：reports，不是report。
• 文件需描述資料表用途或內容。

欄位名稱

Camel case，採用26個英文字母(全小寫)和0-9的自然數。

• 欄位命名盡量以能一眼識別欄位用途為主. 例如：使用gender來當作性別欄位名稱，而不是用gdr這種縮寫。
• 命名以不超過三個單字為主。
• 不需重複資料表的名稱。 例如：只用userId，而不是companyUserId。
• 除非長度或安全性因素，否則盡量避免使用縮寫。 例如：使用userId，而不是usrId。

常用欄位舉例

以下描述常用通用名稱，跨專案時若是有相同功能的欄位，以通用名稱為優先首選。

• gender
• age
• createdAt
• updatedAt
• deletedAt