2016年5月15日 星期日

API命名


語意是變數名稱中最重要的一部份,”published”, “unpublished” 意味著產品的狀態,所以最簡單最簡單的 pattern,就是 Adj. + N. 就可以是一個清楚的變數名稱。

單數複數表示也很重要,當我們採用複數命名,其意味著該變數很可能是一個 array 類型、collection 類型、traversable 類型的資料。

  • get => 取得否些屬性會數值
  • set => 和get一樣 不該用在資料庫操作
  • query => api操作 帶參數
  • do => 沒啥意義, 可用update, _update,  _update的scope通常為private
  • fetch / store => 同query, 但fetch通常不帶有複雜的操作
  • build => 建置需要的資料, 還沒那麼明確, 建置資料 準備給其他的東西用 但還沒到資料庫
  • create => 建置到資料庫, 有明確的目標和範圍
  • new => 初始化
  • remove => 從資料集中移除項目 移除關連
  • delete => 刪除 實體資料刪除
  • traverse => 處理tree
 

沒有留言:

張貼留言