想要寫出容易閱讀程式碼(草稿)

無瑕的程式碼(Clean Code)這本書,第一章就說到:

沒有辦法不先讀程式碼就去寫程式,所以讓程式碼更容易閱讀,也會讓程式碼變得更容易撰寫。

可見得寫出令人容易閱讀的程式是一件多麼重要的事,一位專業的程式設計師就是能寫出讓人一目瞭然的程式碼。

What Makes Code Readable: Not What You Think在這篇文章,提到寫出可讀性高的程式碼,有下列幾個標準答案:

  • 良好的變數、方法、方法命名。
  • 讓變數、方法、方法只有單一功能。
  • 一致性的縮排和格式。
  • 減少巢狀的程式碼。

取個好名字很重要

從良好的變數、方法及類別名稱,可以代替過多的註解,若是用問題領域的術語命名,更能將程式碼和問題領域的概念結合起來。

在看程式碼時,經驗豐富開發者和新手最大差異,是前者不太會花時間在程式的語法上,把注意力都放在程式實際要表達的概念,這程式目的要做什麼?而不是如何去做?而後者卻把焦點都放在程式結構或語法上面。