首页 > 业内资讯 > 提高代码质量:如何编写函数

提高代码质量:如何编写函数

时间:2016-02-23 | 来源:developerWorks | 阅读:166

话题: developerWorks

根据不同项目和需求制定好命名规则

这一点也是很重要的,尤其是在团队合作中,不同的项目和需求可能导致的不同的命名规则。
比如我们通常采用的命名规则是动宾结构,也就是动词在前,名词灾后。但是有一些项目,比如数据接口等项目中,有的团队会采用名字在前,动词在后的形式,例如:

public static Product[] ProductsGet(){}; public static Product[] ProductsDel(){}; public static Customer[] CustomerDel(){}; public static Customer[] CustomerDel(){};

这种的好处是看到前面的名词,比如ProductsGet,就能很快的知道这是产品相关的数据接口。
当然这个并不是绝对的,关键还是要团队共同制定和遵守同一套命名规则。

函数参数

函数使用者在调用函数时,必须严格遵守函数定义的参数,这对函数的易用性,可测试性等方面都是至关重要的。下面我从几个方面来谈谈关于如何优化好函数参数的一些想法。

参数数量

毫无疑问,函数参数越多,函数的易用性就越差,因为使用者需要严格眼中参数列表依次输入参数,如果某个参数输错,将导致不可意料的结果。
但是,函数参数就一定越少越好吗?我们来看看下面的例子:

var count = 0; var unitPrice = 1.5; .... ... var calculatePrice = function () { return count * unitPrice; }

在这个例子中,我们通过calculatePrice这个函数来计算价格,函数不接收任何参数,直接通过两个全局变量unitPrice和count进行计算。这种函数的定义对使用者来说非常方便,直接调用即可,不用输入任何参数。但是这里可能会有潜在的bug:全局变量可能在其他地方被修改成其他值了,难以进行单元测试等等问题。所以,这个函数可以传入数量和价格信息:

var calculatePrice = function(count, unitPrice) { return count * unitPrice; }


湘ICP备2022002427号-10湘公网安备:43070202000427号
© 2013~2019 haote.com 好特网