全栈工程师程序员

第三章 函数

2017-08-11  本文已影响9人  Dl_毛良伟

短小


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


只做一件事


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

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

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

上一篇下一篇

猜你喜欢

热点阅读