clean code笔记2:函数

编写函数的规范

沃德原则:如果每个历程都让你感到深和己意,那就是整洁的代码

基本规范

  • (最为重要的一点)函数体尽可能短小尽可能短小
  • 一个函数只做一件事,并做好这件事。要判断函数是否只做了一件事,有一个办法是看在你编的函数里,你能否再拆出一个函数
  • 将switch埋藏在较低的抽象层级。

函数参数

  • 参数名,最好和函数名有联系。这样可以,大大减轻记忆参数的负担
  • 禁止把布尔值传入函数。因为这样做,意味着,宣称本函数不只做一件事:ture时做一件事,false时则在做另外一件事。
  • 函数参数的个数尽可能少!最理想的参数数量是零。这个规则,使得用函数更简单,还使得测试函数得到了方便,因为输入的参数少了,困难麻烦就少了。
  • 多元函数中,函数参数尽量是单个值的有序组成部份,或者多个有序的值,有序性是很重要的,如果函数参数之间无序,你无法很快知道某个参数的作用。
  • 如果参数有多个的话,可能需要将参数封装成对象。
  • 应该避免使用输出参数,当某个函数必须要修改某个变量的时候,还不如修改所属对象的状态。这样以来我们可以通过对象来分析参数的意义,而仅仅通过某个变量所获取的会不足。比如changeGrade(grade)来调用显然没有student.changeGrade()舒服。

函数的抽象层(重点)

  • 函数的抽象层级以功能来划分,比如去买书,抽象层级:买书>去书店>走路
  • 函数的抽象层级的最高层类似于人类自然语言,使代码清晰易懂,简洁。
  • 确保,每个函数,一个抽象层级,也就是说一个函数中的语句都要在同一抽象层级上
  • 我们想要让代码拥有自顶向下的阅读顺序,因此让每个函数后面都跟着下一抽象层级的函数,此举方便了以后修改代码和阅读代码。

函数编写细则

  • 不要重复自己,重复的代码难以修复,且可读性差,应该把重复的代码写成函数。
  • 函数应该只做一件事,当做了多件事的时候就很容易产生副作用。
  • 在对函数测试的时候,函数应该剔除所有副作用。
  • 函数要么“做什么事”,要么“回答什么事”。即是将指令和询问分隔开来
  • 抽离try/catch代码块,他们会搞乱了代码结构,把错误处理正常流程混为一谈。所以应该把其主体部分抽离出来,另外写成函数。错误处理的代码应该就是包含它的函数的所有代码

结语

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

推荐阅读更多精彩内容