千萬不要把 bool 當成函數參數

我們有很多 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 3

TNND，那個 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”。