常用命名

秦曉武發表於2020-12-04

為了程式碼能讓人一眼看明白對應功能,開發中需要讓函式和變數的命名統一和精確,在此把一些常用命名方式做個記錄(英文不好,逐步完善中)

字首

單詞 說明 場景 例子
create 建立 建立資料時 createData()
update 更新 更新資料時 updateData()
delete 刪除(軟刪除) 刪除資料時,一般是資料庫標記刪除狀態 deleteData()
destroy 刪除(硬刪除) 刪除資料時,一般是物理永久刪除 destroyData()
push 推送 主動傳送資料給第三方時 pushMessage()
notify 通知 被動接受資料時 notifyMessage()
handle 處理 處理單一業務時 handleError()
fetch 取值 渲染頁面時 fetchList()
get 獲取 獲取類的屬性 getId()
set 設定 設定類的屬性 setId()

字尾

單詞 說明 場景 例子
array 陣列 代表變數是個陣列 $user_array
list 列表 一般是資料庫查詢的結果集 $user_list
info 資訊 一般是資料庫查詢的單條資訊 $user_info

連線詞

單詞 說明 場景 例子
to 轉換 一般是型別轉換 string_to_array()
re 關聯 關聯兩組資料 user_re_coupon()

縮寫

單詞 說明 例子
arr 陣列 array
str 字串 string
本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章