第三章 函数

短小


  • 函数的第一规则是要短小,第二规则是还要更短小。20行封顶最佳

  • if语句、else语句、while语句等,其中的代码块应该只有一行。

一个函数调用语句,块内调用的函数应拥有较具说明性的名称。
这也意味着函数不应该大到足以容纳嵌套结构。所以函数缩进的层级不应多于一层或两层。这样的函数易于阅读和理解。因此当我们在一个函数内写的代码行数过多时,就要想办法将一些代码抽出来,减少代码阅读的复杂性。


只做一件事


函数应该做一件事。做好这件事。只做这件事。

判断一个函数是否只做一件事

  1. 看代码中是否有处于多个不同抽象层级的步骤。
  2. 能否在拆出一个函数出来

有时候我们会在一个函数中做多件事,就是应为我们在给函数命名时的随意,搞不清楚这个函数真正的功能是啥。


每个函数一个抽象层级


要确保函数只做一件事,函数中的语句都要在同一抽象层级上。

向下规则:让代码拥有自顶向下的阅读顺序。每个函数后面都跟着位于下一抽象层级的函数,这样一来,在查看函数列表时,就能循抽象层级向下阅读了。

类似这样的程序,像是一系列【要】(原文是To)起头的段落,每一段都描述当前抽象层级,并引用位于下一抽象层级的后续【要】起头段落:

  • 要容纳设置和分拆步骤,先容纳设置步骤,然后纳入测试页面内容,再纳入分拆步骤
  • 要容纳设置步骤,如果是套件,就纳入套件设置步骤,然后再纳入普通-
    设置步骤
  • 要容纳套件设置步骤,先搜索“SuiteSetup”页面的上级继承关系,再添加一个包括该页面路径的语句
  • 要搜索...

这是一个让函数写更少代码的方法


使用描述性的名称


长而具有描述性的名称,比短而令人费解的名称+描述性的长注释好。

命名方式要保持一致

includeSetupAndTeardownPages、includeSetupPages、includeSuiteSetupPage和includeSetupPage

函数参数


最理想的参数数量是零,其次是一,再次是二,尽量避免三。


抽离Try/Catch代码

将try/catch代码隔离出来,避免影响主程序逻辑。
Demo:

 Try{  
     DeletePage(page);//DeletePage是一个方法 
}Catch(Exception e){  
     LogError(e);//LogError是一个方法
}  

错误处理就是一件事。 try/catch总是单独出现的,里面可以最好不要包含普通语句,如上例。 别重复自己,重复是一切邪恶的根源。这个显然很重要,但是并不容易做到。重复有明显的重复,有隐蔽的逻辑重复,结构重复。总之如果能够在消除重复上更进一步、多做一些,对个人职业生涯和公司都有好处,并且可以很快感受到。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容