[獨自murmur]function命名時,正確地使用對立名稱

  • 4489
  • 0

摘要:[獨自murmur]function命名時,正確地使用對立名稱

reference: Code Complete2, Ch7-3, Good Routine Names: Use opposites precisely

function的命名,一向是很多程式裡面造成可讀性低的一大問題,
好的程式應該具備「自我文件化」的特性,也就是人家可以直接從您的code,瞭解您要表達的意思。
尤其是function通常是代表一個抽象化的概念,命名就變得格外重要。

 

好的function name通常都會包括了動作與目標物件,
所以,瞭解一些特定的term,便是一個好的coding rule應該限定的範圍,
當大家都遵守這樣的規範的時候,才能用同樣的語言進行溝通。

 

下面這張表是書中提及,對立的「動作」名稱,為了維持它的美感,我就不特地翻成中文了,對term有問題的人,
大家再來討論看看適用於什麼樣的情形。
這張表並非絕對正確,但是可以提供給我們當作一個指標性的參考。

  • add/remove
  • increment/decrement
  • open/close
  • begin/end
  • insert/delete
  • show/hide
  • create/destroy
  • lock/unlock
  • source/target
  • first/last
  • min/max
  • start/stop
  • get/put
  • next/previous
  • up/down
  • get/set
  • old/new

 


blog 與課程更新內容,請前往新站位置:http://tdd.best/