Skip to content

Instantly share code, notes, and snippets.

@hatelove
Created April 15, 2013 05:23
Show Gist options
  • Save hatelove/5385893 to your computer and use it in GitHub Desktop.
Save hatelove/5385893 to your computer and use it in GitHub Desktop.
Hi folks,
這邊有一篇王建興前輩針對區域變數命名長度的見解,講的挺清楚的,雖與我們現行不盡相同,但看一下對大家肯定會有幫助。
請參考: http://www.ithome.com.tw/itadm/article.php?c=68698
整篇文章最重要的就是: 範圍的大小,影響命名的講究程度
一般來說,如果您可以做到以下條件同時成立,命名不用太長沒關係:
1. 一個function的內容,或是該變數生命週期,不到一頁的長度
2. 簡寫是常見、有意義、不會造成誤解的命名
那我們為什麼還要這麼講究naming rule, 避免簡寫呢?
因為在團隊開發以及產品存活生命週期很長的情況下,任何一段程式碼,都可能會被後面的人因為issue緊急程度而被修改,後面維護的人員當時的任務重點可能在於要緊急修復問題,而不是程式碼到底要命多長。
再還沒進行重構之前,原本預期變數很簡短的生命週期,可能會因此而被拉長,甚至為了naming rule一致性,避免同一個意義存在兩種命名,而把後面的命名也都改成簡寫,因而產品可能因為一開始良好的立意,導致後面越活越糟。當然,這樣的情況還是可以透過很多輔助方式來避免。
但最後,成本最低的policy,就是一開始就限定大家盡可能的不要使用簡寫。因為對寫程式的成本來說,真的不會太高。
簡寫在某些情況下,可讀性的確是比全名高的,但因為很多時候會是組合字,組合字越來越多時,簡寫原本單純的意義,會顯得越來越複雜。
因此,比較輕鬆的方式,還是建議code convention可以訂成全名。再依據code review的情況,來重構調整不好懂的全名命名。
Regards,
Joey
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment