程式設計技巧

撰寫優良程式碼的一般技巧


為函式命名

挑選好的函式名稱,是寫出好程式碼不可或缺的一環。命名函式時,不妨參考以下幾個建議。

選擇有意義的函式名稱

命名函式時,你應該清楚它到底在做什麼。舉例來說,get(studentId, subject) 這個函式沒有有意義的名稱,因此看不出它到底在做什麼。它可能是要取得學生的科目成績,也可能是要查詢他的選課狀態。比較好的名稱是 getStudentGrade(studentId, subject),因為它精確傳達了這個函式的用途。

函式名稱不要太長

小心別把函式名稱取得太長。舉例來說,checkStudentFailOrPassOrMeritOrDistinction(mark) 就是個沒必要那麼長的函式名稱。名稱越長,就越難記住,在螢幕上佔的空間也越多。

函式名稱不要太短

反過來說,函式名稱取得太短同樣會讓讀者困惑。舉例來說,checkFPMD(mark) 就是個糟糕的函式名稱,因為一眼看不出「FPMD」代表什麼。

使用大家都懂的名稱

你的函式名稱應該讓每個讀你程式碼的人都能理解。舉例來說,像 DeathStar() 這種冷僻的函式名稱,也許讓你覺得有趣,但這個名稱並沒有傳達它的用途,還可能讓其他讀你程式碼的開發者一頭霧水。

為同類操作選定一套命名慣例

對於做同一件事的操作,請固定使用同一套命名慣例。舉例來說,如果你把取得學生姓名的函式命名為 getStudentName(),那麼取得學生成績的函式就不該改用另一個動詞(例如 retrieveStudentGrade())。

避免同一個字有兩種用途

舉例來說,如果你已經用 add 來表示兩個數字相加,就別在把一組項目放進集合時也一直用 add。改用 insert 或 append 吧。