我們有很多 Coding Style 或 代碼規(guī)范。 但這一條可能會(huì)經(jīng)常被我們所遺忘,就是我們 經(jīng)常會(huì)在函數(shù)的參數(shù)里使用bool參數(shù),這會(huì)大大地降低代碼的可讀性。 不信?我們先來(lái)看看下面的代碼。
當(dāng)你讀到下面的代碼,你會(huì)覺(jué)得這個(gè)代碼是什么意思?
widget->repaint(false);是不要 repaint 嗎?還是別的什么意思?
看了文檔后,我們才知道這個(gè)參數(shù)是 immediate,也就是說(shuō),false 代表不立即重畫(huà),true 代碼立即重畫(huà)。
Windows API 中也有這樣一個(gè)函數(shù):InvalidateRect,當(dāng)你看到下面的代碼,你會(huì)覺(jué)得是什么意思?
InvalidateRect(hwnd, lpRect, false);我們先不說(shuō) InvalidateRect 這個(gè)函數(shù)名取得有多糟糕,我們先說(shuō)一下那個(gè) false 參數(shù)? invalidate 意為 “讓XXX無(wú)效”,false 是什么意思? 雙重否定? 是肯定的意思?
如果你看到這樣的代碼,你會(huì)相當(dāng)?shù)馁M(fèi)解的。 于是,你要去看一下文檔,或是 InvalidateRect 的函數(shù)定義, 你會(huì)看到那個(gè)參數(shù)是 BOOL bErase,意思是:“是否要重畫(huà)背景”。
這樣的事情有很多,再看下面的代碼,想把 str 中的 ”%USER%” 替換成真實(shí)的用戶(hù)名:
str.replace("%USER%", user, false); // Qt 3TNND,那個(gè) false 是什么意思?不替換嗎?還是別的什么意思?
看了文檔才知道,false 代表: “大小寫(xiě)不敏感的替換”。
其實(shí),如果你使用枚舉變量/常量,而不是 bool 變量,你會(huì)讓你的代碼更易讀,如:
widget->repaint(PAINT::immediate);
widget->repaint(PAINT::deffer);
InvalidateRect(hwnd, lpRect, !RepantBackground);
str.replace("%USER%", user, Qt::CaseInsensitive); // Qt 4如果對(duì)這個(gè)事不以為然的話(huà),我們?cè)賮?lái)看一些別的示例,你不妨猜猜看看下面的代碼:
component.setCentered(true, false);
這什么玩意兒啊?
看了文檔你才知道,這原來(lái)是 setCentered(centered, autoUpdate);
new Textbox(300, 100, false, true);這又是什么啊?
看了文檔才知道,這是創(chuàng)建一個(gè)文本框,第三個(gè)參數(shù)是:“是否要滾動(dòng)條”,第四個(gè)是:“是否要自動(dòng)換行”。TNND!
這種情況還不算最差,看看下面的雙重否定。
component.setDisabled(false);
filter.setCaseInsensitive(false)再來(lái)一個(gè),如果你讀到下面的代碼,相信你會(huì)和我一樣,要么石化了,要么凌亂了。
event.initKeyEvent("keypress", true, true, null, null,false, false, false, false, 9, 0);
看完這篇文章,我希望你再也 不要把bool為作為函數(shù)參數(shù)了。除非兩個(gè)原因:
你 100% 確認(rèn)不會(huì)帶來(lái)閱讀上的問(wèn)題,比如 Java 的 setVisible (bool).
你 100% 確認(rèn)你想去 寫(xiě)出迷一樣的代碼。
如果你想設(shè)計(jì)一個(gè)好的 API,強(qiáng)烈推薦你讀一下 Nokia 的 Qt 的《API Design Principles》,本文就是其中的 “Boolean Trap”。