發布日期:Jul 1, 2021
文章於 Jul 6, 2021 更新
(一)
關於命名的注意事項
舉例:
【後綴式命名】
PRODUCT_TYPE_CODE_FRUIT
PRODUCT_TYPE_CODE_TOY
PRODUCT_TYPE_CODE_BOOK
搜尋時如果想找 PRODUCT_TYPE_CODE 系列的片段,會把所有產品種類的片段都標起來。
如果想要找特定某一類產品,則需要搜尋到產品種類的第一碼例如「PRODUCT_TYPE_CODE_T」
【穿插式命名】
PRODUCT_TYPE_FRUIT_CODE
PRODUCT_TYPE_TOY_CODE
PRODUCT_TYPE_BOOK_CODE
搜尋時以「PRODUCT_TYPE_T」搜尋即可。
兩種感覺差別不大,使用習慣的問題?
e.g.
getEmployeeCollection()
取員工資料集,回傳 Collection 物件。 setChartTitle() 設定圖表標題,不見得會回傳材料,可能只回傳「是否設定成功」而已。 mapEmployeeDepartmentArray() 建立員工與部門的對照表,回傳 Array
$is_already_login $is_paid
getProductCollection() getExpiredProductCollection() getExpiredProductCollection() 會呼叫 getProductCollection() ,只是在呼叫時限縮範圍為已過期產品。
好的命名能讓人真的用「閱讀意義」的方式去了解程式碼,對於維護會有很大的助益。
也許未來在開發專案時可以一邊收集紀錄專案內的命名邏輯範例,避免一時腦袋不清楚亂命名。
確立並內化一套命名規則。好處是可以減少命名上的遲疑時間,也能減少追溯變數源頭內容的時間。
命名邏輯的確立是有價值的投資。