統一的命名規範能大幅提升程式碼可讀性與維護效率。本文整理兩種主流命名法,並說明避免使用 sp_ 前綴的效能考量。
[proc]_[MainTableName]_([FieldName]_)[Action] -- 單數:單筆操作
[proc]_[MainTableNames]_[Action(Condition)] -- 複數:多筆/集合操作
proc_OfferThread_Create
proc_OfferThread_Update
proc_OfferThread_Delete
proc_OfferThread_Status_Update
proc_OfferThread_PrevNext
proc_OfferThread_Get -- 預設依 ID 查詢
proc_OfferThreads_Get
proc_OfferThreads_GetByName
proc_OfferThreads_Delete -- 批次依使用者編號刪除
proc_OfferThreads_DeleteByUserName
proc_OfferThreads_DeleteByName
proc_OfferThreads_GetThreadSet -- 分頁查詢
proc_ 前綴sp_:SQL Server 會優先搜尋系統預存程序,導致效能微幅下降[proc] [MainTableName] By [FieldName(optional)] [Action]
| 操作類型 | 後綴 | 範例 |
|---|---|---|
| 查詢單筆 | Select | procClientByCoNameSelect |
| 新增資料 | Insert | procEmailMergeInsert |
| 更新資料 | Update | procClientUpdate |
| 新增或更新 | Save | procOrderSave |
| 刪除資料 | Delete | procLogDelete |
| 重建表結構 | Create | procTempTableCreate |
| 回傳輸出參數 | Output | procCalcTotalOutput |
-- 舊
procGetRate, sp_GetRate, procEmailMergeAdd
-- 新
procClientRateSelect, procEmailMergeInsert
結合兩法優點:採用 proc_ 前綴 + 單複數區分 + 標準動詞後綴,並明確記錄專案命名規範文件,納入 Code Review 檢核項目。