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

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

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

话题: developerWorks

这只是简单的一个例子,实际开发中可能会遇到得更多复杂的情况,单一职责原则是我们开发函数要遵守的准则,但是有时候无法做到函数单一职责时,请记得函数名应该尽可能地描述所有事情。当你无法命名一个函数时,应该分析一下,这个函数的编写是否科学,有什么办法可以去优化它。


采用准确的描述动词

这一点对母语非英语的开发者来说应该是比较难的一点,想要提高这方面的能力,最主要的还是要提高词汇量,多阅读优秀代码积累经验。

这里简单说说我自己的一些感想和看法:
1、不要采用太抽象广泛的单词
很多开发人员会采用一个比较宽泛的动词来为函数命名,最典型的一个例子就是get这个单词。我们平时开发中经常会通过各种不同的方式拿到数据,但是每一种方式都用get就有点太抽象了。具体如何命名,要具体分析:
(1)简单的返回数据

Person.prototype.getFullName = function() { return this.firstName = this.lastName; }

(2)从远程获取数据

var fetchPersons = function () { ... $.ajax({ }) }

(3)从本地存储加载数据

var loadPersons = function () {};

(4)通过计算获取数据

var calculateTotal = function () {};

(5)从数组中查找数据

var findSth = function (arr) {};

(6)从一些数据生成或得到

var createSth = function (data) {}; var buildSth = function (data) {}; var parseSth = function(data) {};


这是一个简单的例子,我们平时开发中遇到的情况肯定会复杂得多,关键还是靠单词的积累,多阅读优秀源码


下面是整理的一些常用的对仗词,大家可以参考使用

add/remove increment/decrement open/close begin/end insert/delete show/hide create/destory lock/unlock source/target first/last min/max star/stop get/put next/previous up/down get/set old/new


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