BT

专栏:代码之丑(六)——分家的声明和使用

| 作者 郑晔 发布于 2010年11月30日. 估计阅读时间: 不到一分钟 | 道AI风控、Serverless架构、EB级存储引擎,尽在ArchSummit!

这是一段长长的C++代码,我的问题是:relaPri、relaSec和 scoutBySec这三个变量在哪里用到了?

void DealForServiceA(const char *oprCode, const char *subID, const char *oID, XList *callCicsList) {
    XString relaPri(“NULL”);
    XString relaSec(“NULL”);
    XString scoutBySec(“0”);
    XList *tempList = new XList ;
    callCicsList->Add(tempList);
    tempList->Add(new XString(oprCode));
    tempList->Add(new XString(oID));
    XString *psTelNum = new XString;
    tempList->Add(psTelNum);
    GetServnumberBySubsID(subID, *psTelNum);   
    tempList->Add(new XString(relaPri.table { font-size: 10pt;}c_str()));
    tempList->Add(new XString(relaSec.c_str()));
    tempList->Add(new XString(scoutBySec.c_str()));
} 

经过认真仔细的查看,或是使用传说的中“查找”功能,我们发现上面提到的那三个变量只在最后用了一下。

不知道你是否注意到,我在最初特意强调了一下这是C++代码。这意味着,变量可以随用随声明,而不必像传统的C程序那样,只能在函数的开头把函数内部用到的变量一口气声明。 那么 ,我们就让声明和使用团聚吧!

XString relaPri(“NULL”);
tempList->Add(new XString(relaPri.c_str()));
XString relaSec(“NULL”);
tempList->Add(new XString(relaSec.c_str()));
XString scoutBySec(“0”);
tempList->Add(new XString(scoutBySec.c_str())); 

当声明和使用走到一起,我们的观察就有了新的视角,其实,这几个变量完全是可以不声明的,于是,代码再进一步:

tempList->Add(new XString(“NULL”));
tempList->Add(new XString(“NULL”));
tempList->Add(new XString(“0”)); 

看到这里,我们就可以看出原来的做法到底有多么浪费:浪费时间给变量起名字——我们都知道,起个好名字不容易,也 浪费了时间在执行上,修改前的代码创建了两个XString对象,而修改后,只创建了一个对象。

或许,你会觉得,有个变量会让我们了解这里实际上填加的内容到底是什么。不过,也许一个好的函数命名才是更好的选择,比如addRelaPri。这个疑问会揭示出这段代码存在另外一个问题,直接使用基本的数据结构而没有进行封装。不过,这不是这里讨论的目标,就到此打住吧!

根据这段代码的调整,我们得出一条规则:

  • 代码的声明和使用应尽量接近。

有的C程序员会暗自念叨,这个要求对C程序来说,简直太不合情理了。好吧!我承认,从语言的角度来说,是这样的。但是,我们需要仔细想想,为什么对于C语言来说,变量的声明和使用会距离遥远。通常,遥远的背后意味着硕大的函数,这才是让声明和使用天各一方的重要原因。

在干净代码的世界里,大函数永远是不受欢迎的。为了让声明和使用尽早团聚,请把函数写小。

作者简介:

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

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

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

小函数+声明使用团聚 by Cui Anders

小函数是比较理想的情况,实际情况是,我遇到过超过两千行的函数,没办法也不允许去重构这些代码,这时候就让人向往声明使用的团聚了。

看着他抄啊抄,但是有胆量写出来,还是直接鼓励的 by huang danny

看着他抄啊抄,但是有胆量写出来,还是直接鼓励的

Re: 小函数+声明使用团聚 by jialiang liang

我还没碰过2000+行的代码,但是一般比较大的函数(50+),我都可以找到很多可以重构的地方,或者是重复代码,或者是不同职责的代码混杂在一起。 2000 + 的大函数不可能找不到重构的地方吧?

Re: 小函数+声明使用团聚 by Cui Anders

是可以找到重构的地方,但是是维护他人的代码,无权去做这样重构。我想说的就是,阅读长代码的时候,声明和使用的距离显得特别让人头疼:)

Re: 小函数+声明使用团聚 by Peng Shawn

如果你使用的技术或者语言,有非常方便的XUnit测试框架,我劝你真得尝试一下,否则真得没有人能保证重构不出现问题。

Re: 小函数+声明使用团聚 by Peng Shawn

如果你使用的技术或许语言,可以方便的使用XUnit,你真应该尝试一下,否则真得不要去动它了,除非非动不可。

Re: 小函数+声明使用团聚 by Zhao Qing

重构2000行的函数一定很过瘾 呵呵。

专栏:代码之丑(六)——分家的声明和使用 by 施 建雄

很不错,继续转载到我的博客【www.ackarlix.com/】

Re: 看着他抄啊抄,但是有胆量写出来,还是直接鼓励的 by Zeng Abrams

不错,老写些书上有的东西,不是说写的东西有问题,而是找不到新东西就不要写出来,抄有什么意思啊,烦死了,还老上头版

在大函数里需要局部使用的区域通过花括号分割一个局部区域来方便定义变量即可 by Zhu Nickel

即使在C语言里都可以这样使用
void DealForServiceA(...)
{
...
{
void * handle = ????;
setHandle(handle);
}
...
}

Re: 小函数+声明使用团聚 by 糕点 沉默的

2000+行实在太小儿科,我现在维护的一个函数就有8k多行,我为了改几个bug,加了300行进去。另外一个代码文件就200多K,里面有什么我都不敢看。

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

11 讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT