[基礎]命名規則

剛出來寫程式,還是一張超級白紙時,覺得命名就是讓人看得懂變數就好啦~現在好想回頭揍自己 ಠ▃ಠ

命名有兩個關鍵是:

  1. 可讀性
  2. 一致性

Snake Case, Pascal Case, Camel Case 這三種是較常被採用的命名方式,像像在目前專案上,變數則是使用Snake Case,但在Function則使用Pascal或Camel Case

Snake Case

單字皆為小寫,單字以底線_分離。例如:user_name

Pascal Case

跟 Camel Case 類似,只是第一個字要大寫。例如:UserName

Camel Case(駝峰式)

第一個字母為小寫,之後每一個單字的開頭為大寫,不包含空格。
例如:userName

Kebab Case

跟Snake Case類似,單字以減號-分離。例如:user-name
較常在html裡面的class、div、id看到

Screaming Case

跟Snake Case類似,單字皆為全大寫。例如:PROJECT_NAME
常用地方:全域變數或設定檔內的變數。

我在取名字會盡量保持幾個原則

  • 不超過40個字
  • 不使用羅馬拼音(例如Jiancha,唸法就同檢查)
  • 使用有意義或公認的英文縮寫
  • 變數使用名詞或形容詞,有關function或操作的使用動詞
  • 選擇好溝通的英文
  • 好搜索,例如id,就加個user_id或admin_id,不然用id搜尋整個專案,出來可能會有上千個id…

發佈留言

內容索引