- 寫短而簡潔的函式
程式碼太長的後果是沒人知道這一大段東西到底在幹嘛，因而不敢（或不願意）去修正它。要怎麼判斷一個函式是否太長了呢？有個我很喜歡的簡單準則，大家可以參考一下：
一個函式的長度不應該超過螢幕能顯示的範圍。
- 可以自我詮釋的變數與函式名稱
變數或是函式的名稱應該要清楚地說出變數與函式的用途。現在的編輯器都支援名稱提示與自動完成的功能。不要為了想少打幾個字，而取那種過了一個星期之後連你自己都不知道是什麼意思的式名稱。
- 只寫恰當的註解
註解裡面只要指出程式碼裡面沒有的東西（參數格式、呼叫此函式前應該被滿足的條件等...）就好了。最好可以搭配一些文件產生工具（如 javadoc）自動地產生說明文件。
- 保持程式碼易讀好懂
不要用一些奇技淫巧來賣弄你的程度，因為日後可能連你自己都看不懂你在寫什麼。遵守 "KISS" (Keep It Simple and Stupid) 與 "DRY" (Don't Repeat Yourself) 這兩個原則，自然就可以寫出易讀好懂的程式碼。
繼續用轉錄翻譯文章來充版面...
沒有留言:
張貼留言
注意：只有此網誌的成員可以留言。