首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 开发语言 > 编程 >

万万不要把 bool 当成函数参数

2012-12-26 
千万不要把 bool 当成函数参数我们有很多 Coding Style 或 代码规范。 但这一条可能会经常被我们所遗忘,就

千万不要把 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”。万万不要把 bool 当成函数参数

    原文链接:http://coolshell.cn/articles/5444.html

    23 楼 naily 2012-11-23   不敢苟同! 24 楼 hardPass 2012-11-23   感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。
    25 楼 justjavac 2012-11-23   hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。
    26 楼 ynky1026 2012-11-23   我就不说android sdk都是这么写 27 楼 n_lick 2012-11-23   楼主写代码难道不看api就直接写吗?我想第一次用到的函数查api是必须的,
    bool值作为参数,我想api应该说的很清楚了吧
    如果使用了具有api提示功能的ide,查询api也方便了
    若用emacs,vi去写C,我想个人感觉在编辑速度的确有优势,ide的确不如,
    但是emcas,vi的准确率却大大不如ide
    对于不熟悉api,和经常敲错键的人,ide是很好的选择 28 楼 justjavac 2012-11-23   n_lick 写道楼主写代码难道不看api就直接写吗?我想第一次用到的函数查api是必须的,
    bool值作为参数,我想api应该说的很清楚了吧
    如果使用了具有api提示功能的ide,查询api也方便了
    若用emacs,vi去写C,我想个人感觉在编辑速度的确有优势,ide的确不如,
    但是emcas,vi的准确率却大大不如ide
    对于不熟悉api,和经常敲错键的人,ide是很好的选择
    楼主写代码难道不看api就直接写吗? 第一次肯定看api,但是,还是那句话,程序可能写一次,但是以后你、或者你的同事、或者你的接替者、或者调用你函数的程序员……还要看N次

    你写的每个函数,要保证在N个月以后,你看一眼就知道他是什么意思。你写的是程序,开发的是软件,不是为了解决问题而写的一次性脚本。 29 楼 davepkxxx 2012-11-23   看这篇文章的分类貌似是Java,但是Java没有bool,只有boolean。 30 楼 spiniper 2012-11-23   davepkxxx 写道看这篇文章的分类貌似是Java,但是Java没有bool,只有boolean。
    这位兄弟爱钻牛角尖啊,这里是讨论概念,不是写代码,不用让计算机去编译的。 31 楼 kenns2000 2012-11-23   我觉得这是一个命名上的问题:
    如上例中改成:

    widget->needRepaint(false);

    你还会看不懂它的含义么? 32 楼 blackproof 2012-11-23   感觉没什么可说的,也没说的必要 33 楼 李雄略 2012-11-25   楼主的头像有意思 34 楼 hardPass 2012-11-26   justjavac 写道hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。


    好吧,我这么说:
    如果是用eclipse看java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。 35 楼 WingForce 2012-11-26   hardPass 写道justjavac 写道hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。


    好吧,我这么说:
    如果是用eclipse看java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    如果你没有eclipse怎么办? 36 楼 spiniper 2012-11-26   WingForce 写道hardPass 写道justjavac 写道hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。


    好吧,我这么说:
    如果是用eclipse看java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    如果你没有eclipse怎么办?
    那就让我们开发一个eclipse出来,让我们用吧,没有IDE,工程性的项目很难掌控的。 37 楼 qingteng1983 2012-11-26   qq413041153 写道不该苟同啊 楼主,不说bool类型,就说随便一个参数,int string long map之类的,你不看函数说明,你就能知道是干嘛的? 好像不可能吧 在明确的定义也会产生分歧,最终办法还是写好文档 说明自己实现的初衷
    以上尽是愚人短见

    深有同感,如果只看调用接口,不看说明文档或者是阅读定义的源代码,任何接口或者函数都很难理解。最简单的,printf()就无法从调用上看出各参数的意义。
    LZ说的问题在我的工作实践中曾经也遇到过,但当时还真不知道背后有这么多道理,只能跟兄弟们强调,如果bool的作为参数时候,而且该参数很容易造成误解,不如在调用之前声明一个变量,比如:bool isReadonly = false; foo(isReadonly);这样算是一个解决之道吧,虽然多了一行代码。哈哈 38 楼 justjavac 2012-11-27   spiniper 写道WingForce 写道hardPass 写道justjavac 写道hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。


    好吧,我这么说:
    如果是用eclipse看java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    如果你没有eclipse怎么办?
    那就让我们开发一个eclipse出来,让我们用吧,没有IDE,工程性的项目很难掌控的。
    linux算工程性项目吗? 39 楼 zui4yi1 2012-11-27   个人认为:对写一些UI,倒是个很好的建议,提高阅读效率。
    不过对于一些简单的函数,如函数名就已提示功能的,boolean就行了 40 楼 spiniper 2012-11-28   justjavac 写道
    linux算工程性项目吗?
    不明白你如此问是何意,你是想说linux不是在一个IDE环境下写出来的,还是想说linux不是在eclipse下写出来的?或者说linux是java开发但不是在eclipse下开发的?还是想说一个工程性的项目可以不通过IDE就能开发出来。
    就前面两个问题,我不好回答你,毕竟我没开发linux,或许你也回答不了这两个问题,后两个问题我可以回答你,linux不是java开发的,一个工程性项目也可以不通过IDE去开发,有编辑软件和一个编译器即可,我只是想说这是很难的,但不是不可能的。
    我上面所说的可能也有很多问题,欢迎来钻牛角尖。 41 楼 justjavac 2012-11-28   spiniper 写道justjavac 写道
    linux算工程性项目吗?
    不明白你如此问是何意,你是想说linux不是在一个IDE环境下写出来的,还是想说linux不是在eclipse下写出来的?或者说linux是java开发但不是在eclipse下开发的?还是想说一个工程性的项目可以不通过IDE就能开发出来。
    就前面两个问题,我不好回答你,毕竟我没开发linux,或许你也回答不了这两个问题,后两个问题我可以回答你,linux不是java开发的,一个工程性项目也可以不通过IDE去开发,有编辑软件和一个编译器即可,我只是想说这是很难的,但不是不可能的。
    我上面所说的可能也有很多问题,欢迎来钻牛角尖。
    VI 42 楼 WingForce 2012-11-28   spiniper 写道WingForce 写道hardPass 写道justjavac 写道hardPass 写道感慨一下。如果是用eclipse写java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    但是go就麻烦了,我一直在Ubuntu下使用sublime,看自己前一段时间写的代码,都有点痛苦。

    代码也许你只写一次,但是你或者你的同事或者你写的函数的使用者需要阅读N次。


    好吧,我这么说:
    如果是用eclipse看java代码,完全不用担心这个问题,ide很方便的就能tip代码的注释。

    如果你没有eclipse怎么办?
    那就让我们开发一个eclipse出来,让我们用吧,没有IDE,工程性的项目很难掌控的。
    即使有非常强大的IDE,怎么保证每个程序员都能在任何情况下写清楚注释?

热点排行