星期二, 10月 22, 2019

變數的命名

看這篇 The art of naming variables 的紀錄
變數命名的藝術,好吧,對非英語系國家來說,的確是有些難度。作者整理了一些慣例讓大家參考:
  1. Arrays :名詞字尾加上 s ,當複數。
  2. Boolean:變數用 is/has/can 開頭,例如 isOpen/hasWrite/canOpen,函數就用 check 開頭,例如 checkHasPermission()。
  3. Numbers:試著使用 min/max/total 來描述,例如 minBugs / maxPugs / totalFruits
  4. Functions:要有動詞跟名詞,例如 getUser() / calculateTotal() ;轉換的話,可以用 to,例如:toUppser() 。
我本來以為會有講 dict / list 的,但沒有,嗯,順手找了一下
  • List:可以考慮後綴就用 List,例如 namesList ,也有人把 list 擺在前面,例如 listOfNames
  • dict:有找,但沒有特定的慣例,參考 List 的命名作法應該是可以。然後有人這樣用 email_to_contact / ip_to_hostname
寫到這邊想起 Clean code 這本書有一章就是在講這個,直接看別人的讀書筆記/心得吧:

沒有留言: