InfoQ

InfoQ

新闻

我的书签

登录注册 以永久保存书签。

该内容已经被标记书签!

标记书签错误,请重试!

代码之丑(九)——退让的缩进

作者 郑晔 发布于 2010年12月25日

领域
过程 & 实践,
架构 & 设计,
语言 & 开发
主题
Ruby ,
Java ,
动态语言 ,
代码分析 ,
调试 ,
语言 ,
.NET ,
编程 ,
专栏 ,
代码之丑

这是一个让我纠结了很久的话题:缩进。

 for (int j = 0; j < attributes.size(); j++) {
    Attr *attr = attributes.get(j);
    if (attr == NULL ) {
      continue;
    }
    int IsCallFunc = -1;
    if(attr->status() == STATUS_NEW || attr->status() == STATUS_MODIFIED) {
      if(strcmp(attr->attrID(), "CallFunc") == 0) {
        if(0 == strcmp(attr->attrValue(), "1")) {
          IsCallFunc = 1;
        } else if(0 == strcmp(attr->attrValue(), "0")) {
          IsCallFunc = 0;
        }
      }
    } else if (attr->status() == STATUS_DELETED) {
      IsCallFunc = 0;
    }
    ...
  }

不是因为它不够“丑”,而是表现它不那么容易。找出一段能表现它特点的代码轻而易举,但放到一篇文章里,大片的代码还是容易让人怀疑我在偷懒。

咬咬牙,我还是拿出了一段。就是这样一段已经缩进很多层的代码,实际上,也只不过是一个更大缩进中的一小段。而且,省略号告诉我们,后面还有。

回到这段代码上,能出现多层缩进,for循环功不可没。出现这种循环,很多情况下,都是对一个集合进行处理,而循环里的内容,就是对集合里的每一个元素进行处理。这里也不例外。所以,我们先做一次提取:

 for (int j = 0; j < attributes.size(); j++) {
    processAttr(attributes.get(j));
  }
  void processAttr(Attr *attr) {
    if (attr == NULL ) {
      return;
    }
    int IsCallFunc = -1;
    if(attr->status() == STATUS_NEW || attr->status() == STATUS_MODIFIED) {
      if(strcmp(attr->attrID(), "CallFunc") == 0) {
        if(0 == strcmp(attr->attrValue(), "1")) {
          IsCallFunc = 1;
        } else if(0 == strcmp(attr->attrValue(), "0")) {
          IsCallFunc = 0;
        }
      }
    } else if (attr->status() == STATUS_DELETED) {
      IsCallFunc = 0;
    }
    ...
  }

至此,我们去掉了一层缩进,而且因为这个提取,语义也变得很清晰:这个新函数只是处理集合里的一个元素。

接下来,这个函数里面长长的代码是对IsCallFunc进行设值,后面省略的部分会根据这里求出的结果进行处理。所以,这里把processAttr进一步分拆:

void processAttr(Attr *attr) {
  if (attr == NULL ) {
    return;
  }
  int IsCallFunc = isCallFunc(attr);
  ......
}

int isCallFunc(Attr *attr) {
  if(attr->status() == STATUS_NEW
  || attr->status() == STATUS_MODIFIED) {
    if(strcmp(attr->attrID(), "CallFunc") == 0) {
      if(0 == strcmp(attr->attrValue(), "1")) {
          return 1;
      } else if(0 == strcmp(attr->attrValue(), "0")) {
          return 0;
      }
    }
  } else if (attr->status() == STATUS_DELETED) {
    return 0;
  }
  return -1;
}

缩进还有,如果有兴趣,还可以继续分解。这里就到此为止吧!

多层缩进是那种放在代码海一眼就可以认出来的代码,用一条简单的规则就可以限制它:

  • 不允许出现多层缩进。

按照我的喜好,3就意味着“多”了。对于switch,我会给予特别的关照,因为switch一旦出场,条件少了,你都不好意思和人打招呼,再缩进就找不到北了。于是,对switch而言,我以为2就是多了,也就是说,switch里面就别再缩进了。

写代码,千万别退让太多。

作者简介:

郑晔,ThoughtWorks公司咨询师,拥有多年企业级软件开发经验,热衷于探索各种程序设计语言在真实软件开发中所能发挥的威力,致力于探寻合理的软件开发方式,加入ThoughtWorks公司后,投入到敏捷开发方法的实践之中,为其他公司提供敏捷开发方法方面的咨询服务。他的blog是梦想风暴

查看原文:代码之丑(九)

更像重构了 发表人 lee lithium 发表于
Python岂不是很纠结 发表人 haoxiang zhang 发表于
Re: Python岂不是很纠结 发表人 Shi Eric 发表于
确切地说,过多的缩进表明这个方法做了太多事儿! 发表人 高 翌翔 发表于
Re: 确切地说,过多的缩进表明这个方法做了太多事儿! 发表人 朱 敏 发表于
Re: 确切地说,过多的缩进表明这个方法做了太多事儿! 发表人 Shi Eric 发表于
Re: 确切地说,过多的缩进表明这个方法做了太多事儿! 发表人 倪 华杰 发表于
有一个东西叫indent 发表人 junling wang 发表于
再次深切同意了 发表人 zhang xiaofei 发表于
  1. 返回顶部

    更像重构了

    发表人 lee lithium

    extract method

  2. 返回顶部

    Python岂不是很纠结

    发表人 haoxiang zhang

    RT =.=
    见过某牛人写的倒半边金字塔式的python方法,相当宏伟壮观呢。

  3. 返回顶部

    确切地说,过多的缩进表明这个方法做了太多事儿!

    发表人 高 翌翔

    记得 Bob 大叔在 Clean Code 中提到一个方法一件事儿,其实一个 if 判断就是一件事儿,
    最终将多层嵌套转换为多个的嵌套调用,因此提取的子函数名至关重要,否则适得其反!

  4. 返回顶部

    Re: 确切地说,过多的缩进表明这个方法做了太多事儿!

    发表人 朱 敏

    你好,能提供Bob大叔的原帖网址吗?谢谢!

  5. 返回顶部

    有一个东西叫indent

    发表人 junling wang

    自己排版什么的最讨厌了

  6. 返回顶部

    Re: Python岂不是很纠结

    发表人 Shi Eric

    是吗 求看看

  7. 返回顶部

    Re: 确切地说,过多的缩进表明这个方法做了太多事儿!

    发表人 Shi Eric

    是啊 求看看

  8. 返回顶部

    再次深切同意了

    发表人 zhang xiaofei

    看这种代码好头疼

  9. 返回顶部

    Re: 确切地说,过多的缩进表明这个方法做了太多事儿!

    发表人 倪 华杰

    Erlang兄弟表示 没有for,没有do while。。。难道我就不活了么