代码整洁之道(整理二:函数)

背景:接上回,上回说的是变量。

1、函数不能太长。抽离方法和重命名操作,会让函数更清晰。

2、短小。函数第一条规则是短小,第二条规则是更短小。
比如if语句、else if语句、while语句,里面的代码应该只有一行,甚至里面应该是一个函数。(简单的例子:if(isTestPage(pageData))会比if(pageData.endwith("test"))更容易让人看懂,因为if里面的内容抽离出了一个方法,而且多了一个易懂的方法名。当然,我觉得,如果if里的判断简单,就不需要如此,如果if里面的逻辑比较复杂,让人不是一眼就能看明白,就应该抽离出一个函数名)

3、函数应该只做一件事。
这里说的一件事,是说同一抽象层上的一件事。(比如,举个简单的例子,同一个函数里有,校验、读取、写入a系统,写入b系统,等等事情,而如果这些逻辑多简单罗列在一个函数里,这个函数就不算只做一件事,而且代码会冗长,极其难于读懂,而其实这几个逻辑,是同一抽象层的,如果把他们抽离出来,然后都命名成一个易懂的函数名,那么包含他们的大函数,就还算只做一件事,同一抽象层上的一件事。这样,我看这个函数的时候,我不需要看所有的部分,我只需要看我关注的东西。)

4、每个函数一个抽象层级。
这个上面说了。

5、使用描述性的名称。
1)如果函数短小,功能越集中,就越便于取一个好名字。
2)别害怕长名称,长而具有描述性的名称,要比短而令人费解的名称好。长而具有描述性的名称,要比描述性的长注释好。
3)命名也应该有一个约定,而且保持一致(比如一下叫save,一下叫insert,一下叫remove,一下叫delete。)

6、函数参数。
1)函数参数当然是越少越好,最好是没有,其次是一,再次是二,尽量避免出现三个。(但是其实很多情况很难做到)
2)不要出现输出参数,比如:StringBuffer传进去,然后修改,然后调用方法之后,直接使用这个Stringbuffer。list这种集合也有这种情况。(因为,人长久的编程习惯是,参数只做输入,输出应该来自于他的返回值。我曾经就碰到过一个同事,list作为输出参数传进去,之后,半天理解不了)
3)标识参数比较丑陋。比如传一个boolean类型进去,然后,if else分别做处理。因为这就说明这个函数不止做的一件事情。(当然,并不是说完全不能这么做,而是应该避免尽量少的地方这样做,比如在一个地方做一下if else,然后路由到下一个抽象层的函数里,函数名易懂的话也比较容易理解)
4)超过3个参数就应该封装成类。(这里,我觉得并不绝对,因为如果说,你封装成的类,不具有的一个整体概念,而只是为了封装而封装,反而多了一个类,复杂的代码。比如makeCirCle(double x, double y, double radius),封装成makeCircle(Point center, double radius),就可以,因为,画一个圆,圆点、半径就可以了,容易理解,可以封装。但是如果胡吞吐枣的封装,就完全没有意义)

7、函数命名,可以动词加关键字的形式,关键词是跟参数名有关。
比如write(String name),改成writeName(String name)。

8、无副作用。
(函数的命名不能存在副作用,比如存在误导性的东西。
很常见的情况。validateXXX()这种,结果函数里面还存在写操作,就会存在很大的误导性,因为一般说validate只是校验一下而已,结果没想到你还有写操作,你可以把写操作也命名到函数名种去)

9、分割指令与询问。
if(set(a))这样,本意是set进去了就返回true,否则返回false,但是其实是很难理解的,别人可能理解成,如果已经存在过值了,就返回false,从来不存在过就返回true。
你可以命名成setIfExisit。甚至,你可以把set指令和询问分开,if !exist then set。

10、使用异常代替错误码。
函数出现错误,用错误码会加深嵌套的层次,因为函数返回错误码,调用这个函数的外面还需要对错误码进行if else处理,函数的外面的外面还需要这样处理。

11、抽离 try catch代码块。
try catch这种结构,很明显的让人感觉这个函数方法做的不是一件事情。
所以应该尽可能少的地方使用这种代码块,而且尽可能的抽离出来。(我觉得看情况,反正可读性是最基本的标准)

12、别重复自己。
代码重复,这个是肯定不能忍受的。

总结:写代码当作写文章一样,初稿粗陋无序,然后斟酌推敲。代码也一样,开始写的时候,也会比较low,之后打磨代码、分解函数、修改名称,消除重复。(哪有那么时间。。。

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

推荐阅读更多精彩内容