编程规范---千万不要把 bool 设计成函数参数

转载自： 酷 壳 – CoolShell.cn

 

我们有很多Coding Style 或 代码规范。但这一条可能会经常被我们所遗忘，就是我们经常会在函数的参数里使用bool参数，这会大大地降低代码的可读性。不信？我们先来看看下面的代码。

当你读到下面的代码，你会觉得这个代码是什么意思？

1

widget->repaint(false);

是不要repaint吗？还是别的什么意思？看了文档后，我们才知道这个参数是immediate， 也就是说，false代表不立即重画，true代码立即重画。

Windows API中也有这样一个函数：InvalidateRect，当你看到下面的代码，你会觉得是什么意思？

1

InvalidateRect(hwnd, lpRect,  false);

我们先不说InvalidateRect这个函数名取得有多糟糕，我们先说一下那个false参数？invalidate意为“让XXX无效”，false是什么意思？双重否定？是肯定的意思？如果你看到这样的代码，你会相当的费解的。于是，你要去看一下文档，或是InvalidateRect的函数定义，你会看到那个参数是 BOOL bErase，意思是，是否要重画背景。

这样的事情有很多，再看下面的代码，想把str中的”%USER%”替换成真实的用户名：

1

str.replace("%USER%", user,false);  // Qt 3

TNND，那个false是什么意思？不替换吗？还是别的什么意思，看了文档才知道，false代码大小写不敏感的替换。

其实，如果你使用枚举变量/常量，而不是bool变量，你会让你的代码更易读，如：

1

2

3

4

5

6

widget->repaint(PAINT::immediate);

widget->repaint(PAINT::deffer);

 

InvalidateRect(hwnd, lpRect,  !RepantBackground);

 

str.replace("%USER%", user, Qt::CaseInsensitive);// Qt 4

如果对这个事不以为然的话，我们再来看一些别的示例，你不妨猜猜看看下面的代码：

1

component.setCentered(true,false);

这什么玩意儿啊？看了文档你才知道，这原来是 setCentered(centered, autoUpdate);

1

newTextbox(300, 100,false,true);

这又是什么啊？看了文档才知道，这是创建一个文本框，第三个参数是是否要滚动条，第四个是是否要自动换行。TNND。

上面的情况还不算最差，看看下面的双重否定。

1

2

component.setDisabled(false);

filter.setCaseInsensitive(false)

再来一个，如果你读到下面的代码，相信你会和我一样，要么石化了，要么凌乱了。

1

2

event.initKeyEvent("keypress",true,true, null, null,

                    false,false,false,false, 9, 0);

看完这篇文章，我希望你再也不要把bool为作为函数参数了。除非两个原因：

1. 你100%确认不会带来阅读上的问题，比如Java的 setVisible (bool).
2. 你100%确认你想去写出无法维护很难阅读的代码。

【更新2011/9/8】当然，别的参数也会有一样的问题，比如：new Textbox(300, 100, false, true);中的300 和 100，不知道是坐标还是长宽，只不过，一般长度或坐标这样的参数都不会被hard code，都会有变量名，而bool这种参数经常性地被传成true 和 false。 bool参数表现得更为明显一些罢了。

所以，程序中不要出现magic number，true/false 也是一种 magic number。但是，我想告诉大家，从API设计的角度来说，你无法强制调用者用常量来取代true/false，定义成枚举类型是最好的选择。

最后，如果你想设计一个好的API，强烈推荐你读一下Nokia的Qt的《API Design Principles》，本文就是其中的“Boolean Trap”。

辅助：

   

《写出可读代码的艺术》中建议，遇到这种特殊情况，Python 可以这么调用：
connect(user, pass, encryption=True)

C 类语言就这样
connect(user, pass, /*encryption=*/ true)

--------------------------------------------------------------------------------------------------------------------------------------------------

面试题：布尔变量

下面这篇文章是从StackOverflow来的。LZ面试的时候遇到了一道面试题：“如果有三个Bool型变量，请写出一程序得知其中有2个以上变量的值是true”，于是LZ做了下面的这样的程序：

1

2

3

4

5

6

7

booleanatLeastTwo(booleana, booleanb, booleanc) {

    if((a && b) || (b && c) || (a && c)) {

        returntrue;

    }else {

        returnfalse;

    }

}

面试官接着问到，请对你的这个程序改进一下，但LZ不知道怎么改进，于是上StackOverflow上问了一下，下面是StackOverflow上的众网友的回答。再往下看的时候，希望你自己能先想一想怎么改进。

有人说，如果你有下面这样的代码？

1

2

3

4

5

   if(someExpression) {

       returntrue;

   }else {

       returnfalse;

   }

你应该改成：

1

returnsomeExpression;

所以，LZ的代码应该写成：

1

return((a && b) || (b && c) || (a && c));

当然，解法不单单只有一种，还有下面的这些解决：

1）使用卡诺图

1

returna ? (b || c) : (b && c);

2）使用异或

1

returna ^ b ? c : a

3）按照字面

1

(a?1:0)+(b?1:0)+(c?1:0) >= 2

1

a&&b || b&&c || a&&c

4）把Bool当成0和1

1

a&b | b&c | c&a

1

a + b + c <= 2

5）如果bool不能当成0和1，则：

1

2

3

4

5

6

inthowManyBooleansAreTrue =

(a ? 1 : 0)

+ (b ? 1 : 0)

+ (c ? 1 : 0);

 

returnhowManyBooleansAreTrue >= 2;