我們有很多Coding Style 或程式碼規格。 但這一條可能會經常被我們遺忘,就是我們經常在函數的參數裡使用bool參數,這會大大降低程式碼的可讀性。 不相信?我們先來看看下面的程式碼。
當你讀到下面的程式碼,你會覺得這個程式碼是什麼意思?
widget->repaint(false);是不要repaint 嗎?還是別的意思?
看了文件後,我們才知道這個參數是immediate,也就是說,false 代表不立即重畫,true 程式碼立即重畫。
Windows API 中也有這樣一個函數:InvalidateRect,當你看到下面的程式碼,你會覺得是什麼意思?
InvalidateRect(hwnd, lpRect, false);我們先不說InvalidateRect 這個函數名稱取得有多糟糕,我們先說一下那個false 參數? invalidate 意為“讓XXX無效”,false 是什麼意思? 雙重否定? 是肯定的意思?
如果你看到這樣的程式碼,你會相當的費解的。 於是,你要去看文檔,或是InvalidateRect 的函數定義, 你會看到那個參數是BOOL bErase,意思是:「你是否要重畫背景」。
這樣的事情很多,再看下面的程式碼,想把str 中的”%USER%” 替換成真實的用戶名:
str.replace("%USER%", user, false); // Qt 3TNND,那個false 是什麼意思?不替換嗎?還是別的意思?
看了文件才知道,false 代表: 「大小寫不敏感的替換」。
其實,如果你使用枚舉變數/常數,而不是bool 變量,你會讓你的程式碼更易讀,如:
複製代碼代碼如下:
widget->repaint(PAINT::immediate);
widget->repaint(PAINT::deffer);
InvalidateRect(hwnd, lpRect, !RepantBackground);
str.replace("%USER%", user, Qt::CaseInsensitive); // Qt 4如果對這個事不以為然的話,我們再來看一些別的範例,你不妨猜猜看看下面的程式碼:
component.setCentered(true, false);
這什麼玩意兒啊?
看了文件才知道,這原來是setCentered(centered, autoUpdate);
new Textbox(300, 100, false, true);這又是什麼啊?
看了文件才知道,這是創建一個文字框,第三個參數是:“是否要滾動條”,第四個是:“是否要自動換行”。 TNND!
這種情況還不算最差,看看下面的雙重否定。
複製代碼代碼如下:
component.setDisabled(false);
filter.setCaseInsensitive(false)再來一個,如果你讀到下面的程式碼,相信你會跟我一樣,要嘛石化了,要嘛凌亂了。
event.initKeyEvent("keypress", true, true, null, null,false, false, false, false, 9, 0);
看完這篇文章,我希望你再也不要把bool當成函數參數了。除非兩個原因:
你100% 確認不會帶來閱讀上的問題,例如Java 的setVisible (bool).
你100% 確認你想寫出迷一樣的程式碼。
如果你想設計一個好的API,強烈建議你讀Nokia 的Qt 的《API Design Principles》,這篇文章就是其中的「Boolean Trap」。