這篇文章是介紹英文命名規則，根據命名對象、使用情境、狀態等進行分類，並舉出使用範例。
以下是正文。
「每次 review 的時候，好像總是被指正變數名稱⋯⋯」
「作為日本人，用英文命名還是有點困難⋯⋯」
您有這樣的煩惱嗎？
本文將以流程圖的形式，說明「當工程師在英文命名遇到困難時該怎麼辦」！學成後也許就能從菜鳥工程師畢業了！？
※本文根據 Laravel, Vue.js 專案規則為基礎進行解說。內容也包括專案的內部規則，請注意這點。
本文適合以下對象：
以下內容是基於瞭解中學和高中學習內容的前提下進行說明。請知悉。
可參考下方流程圖進行命名：
上圖流程意思大致如下：
接下來會依序介紹各種命名使用情境與範例。
表示日期和時間時，參照以下方式：
// 使用 at 表示時日
updatedAt // 更新時日
importedAt // 匯入時日
// 使用 on 表示時日
deletedOn // 刪除時日
當賦予非 boolean 值的變數時，通常會依照以下規則：
// 例
// 形容詞+名詞
specialCategory // 特殊類別
// 形容詞可以是動詞的被動式(~ed)或 ing 形式
importedPlayerNames // 匯入的多個選手名稱
deletedPlayers // 刪除的多個選手
payingPlayer // 付款的選手
// 若沒有形容詞，僅使用名詞或「名詞+名詞」表示也可以
errorCode // 錯誤代碼
centerImageFilePath // 中央圖片檔案路徑
terminalIdsArray // 包含多個終端 ID 的陣列
// 也可使用 名詞+without/before/after~ 的結構
userWithoutPermission // 無權限的使用者
itemTypeBeforeUpdate // 更新前的商品類型
quantityAfterOrder // 訂單的數量
需要切換顯示/隱藏的 flag 時，可依照以下方式：
// 例
showConfirmationModal
// true: 顯示確認視窗
// false: 隱藏確認視窗
名詞的部分也可放入形容詞+名詞，如(A)所示。
當需要切換某個功能ON/OFF 的 flag 時，可依照以下方式：
// 例
autoScrollEnabled
// true: 自動滾動 ON
// false: 自動滾動 OFF
雖然也可以使用 disabled，但雙重否定可能較不容易理解，因此最好避免使用。
名詞的部分也可放入形容詞+名詞，如(A)所示。
當需要表示存在與否的 flag 時，可按以下方式，需注意詞序的不同：
// 例
soldOutItemExists
// true: 完售的商品存在
// false: 完售的商品不存在
名詞的部分也可放入形容詞+名詞，如(A)所示。
當需要表示是否擁有/包含某物的 flag 時，可依照以下方式：
// 例
containsCheckedOutPlayers
// true: 包含已經 checkout 的選手
// false: 不包含已經 checkout 的選手
名詞的部分也可放入形容詞+名詞，如(A)所示。
以下是表示 boolean flag 的基本形式：
// 例
isNew
isImported // 是否已經匯入。動詞的被動式(~ed)也是形容詞的一種
isOrderable // 是否可訂購。也可使用 動詞+able
由於形容詞本身即可表達意義，因此也有人認為 is 應該可以被省略，這取決於專案內統一的慣例。
// 例
imported // 是否已匯入
deleted // 是否已刪除
updated // 是否已更新
這種命名方式在前端開發中較頻繁使用，常用於事件相關的函數命名。
onRowClicked // 當行被點擊時
onPaginationChanged // 當分頁改變時
onDeleteButtonClicked // 當刪除按鈕被點擊時
onItemDisabled // 當物品被禁用時
// 對象明確的情況，也可使用「on+動詞」的被動式(~ed)
onClicked // 當被點擊時
onSubmitted // 當提交時
// 也有一派認為使用「on+動詞」更好
onClick // 當被點擊時
onSubmit // 當提交時
當需要表示轉換某物時，也可以簡化命名：
// NG...雖然不是不行，但太長了...
const convertTimeFromSecondsToMinutes = (time) => {...}
// OK. 由於參數明確指定為秒數，因此能夠理解這是一個轉換秒→分鐘的函數。
const toMinutes = (seconds) => {...}
當需要表示改變對象狀態的函數時使用：
// 設定收據已印刷
// 表示 receipt = printed
setReceiptPrinted
最常見的函數命名方式：
joinStrings // 串接字串
switchTableWidth // 切換表格寬度
sortCategories // 排序類別
toggleArchivedItems // 切換在庫商品
受詞可以是名詞、名詞+名詞、形容詞+名詞，與(A)相似。
接下來，將根據詞性提供一些命名技巧。
儘管文法上應該以「名詞 of 名詞」方式書寫才對，但這會讓名稱變得過於冗長。
只需將名詞以 2 到 3 個單詞的方式聯接，同樣也能夠傳達意思。
// 雖然不算 NG 但太長了...
codeOfError
pathOfFileOfCenterImage
// OK
errorCode
centerImageFilePath
建議將 id, name, code, response, request, path, url 等單詞放在句尾，開頭接別的名詞，這是很常見的命名方式！
光是單數或複數形式的名詞，就能傳達不同的名稱含義。
// 例1
getSystemConfigs // 取得多個系統設定
updateSystemConfig // 更新一個系統設定
// 例2
playerCount // 玩家數量固定為 1，是常數嗎？
playersCount // 玩家數量以整數存取，代表一個玩家人數
playersCounts // 玩家數量以數組形式存取，代表多個玩家人數，是物件嗎？
由於單數型和複數型有助於名詞的表達，因此不建議使用沒有複數型的名詞（不可數名詞）。
請儘量替換為可數名詞。
// 不可數名詞
data, code, information, software
getData // NG. 無法確定取得的資料是一個還是多個。
getTexts // OK. 明確表示可取得多個資料，且能夠知道資料類型
使用 ~Array, ~Object, ~String, ~Collection 等表示資料型別的名詞，也是推薦的做法。
terminalIdsArray // 包含多個終端 ID 的陣列
您是否曾經為了更容易理解，使命名變得過長呢？
使用名詞的單數/複數型已經能充分傳達訊息，因此也可以省略部分名稱。
// 雖然不算 NG，但太長了...
someItems
allItems
individualItem
// OK. 使用單數/複數型即可表達
items
item
透過在名詞後加上這些詞語，能夠更詳細地表達情境或條件。
能夠掌握這些原則，基本上就已經沒問題了。
userWithoutPermission // 「沒有權限的」用戶
itemTypeBeforeUpdate // 「更新前的」項目類型
itemQuantityAfterOrder // 「下單後的」庫存數量
表達「被～」、「已經完成～」的情況時，使用動詞的被動式 (~ed) 作為形容詞是個不錯的做法。
importedPlayerNames // 被導入的玩家名稱 = 已導入的玩家名稱
deletedPlayers // 被刪除的玩家 = 已刪除的玩家
disabledItem // 被禁用的商品 = 已禁用的商品
limitedQuantity // 被限定的數量 = 已限定數量
表達「正在做～」的情況時，使用動詞的 ing 形作為形容詞是個不錯的做法。
payingPlayer // 正在支付的玩家 = 付費者
~ing 的情況，表示「名詞正在做某個動作」或「即將進行某事」。
~ed 的情況，表示「名詞已經被做了某事」或「已經完成某事」。
payingPlayer // 支付 = 付款的玩家 or 即將付款的玩家
PaidPlayer // 被支付 = 被付款的玩家 or 已付款的玩家
// NG (不建議在開頭接 Not)
notCategorized
notCompleted
// OK (搜尋即可找到相關資訊)
uncategorized
incomplete
否定形容詞通常容易理解，但如果和 if 語句結合使用，可能導致程式碼變得難以理解。
當否定形容詞和否定條件組合在一起時，容易混淆 true 和 false，使程式碼變得不易閱讀且容易造成誤解。
// NG
if (!disabled) {...}
// OK
if (enabled) {...}
請根據下方表格中形容詞的肯定型/否定型，試著撰寫 if 語句。
| 肯定型 | 否定型 |
|---|---|
| visible | hidden |
| public | secret |
| active | inactive |
| enabled | disabled |
| ~ | in~ |
| ~ | im~ |
| ~ | dis~ |
| ~ | un~ |
Be 動詞不會和普通動詞一起使用。
請注意像是「isExists~」的寫法並不正確！
經常使用的動詞(PHP)
偶爾使用的動詞(PHP)
經常使用的動詞(JS)
以上總結程式語言初學者常見的英文命名規則。
iThome鐵人賽
看影片追技術