代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:极速快3_快3诀窍_极速快3诀窍

写出整洁的代码,是每个程序员的追求。《clean code》指出,要想写出好的代码,首先得知道哪几种是肮脏代码、哪几种是整洁代码;只是通过几滴 的刻意练习,有助真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了亲戚亲戚有些人是糟糕代码的受害者。国内有三个 更适合的词汇:屎山,觉得都是很文雅只是更加客观,程序员既是受害者也是加害者。

对于哪几种是整洁的代码,书中给出了大师们的总结:

  • Bjarne Stroustrup:优雅且高效;直截了当;减少依赖;只做好一件事
  • Grady booch:简单直接
  • Dave thomas:可读,可维护,单元测试
  • Ron Jeffries:从不重复、单一职责,表达力(Expressiveness)

其中,我最喜欢的是表达力(Expressiveness)你是什么描述,你是什么词似乎道出了好代码的真谛:用简单直接的办法描绘出代码的功能,太久只是少。

本文记录阅读《clean code》时候当时人“深有同感”是因为“醍醐灌顶”的有些观点。

坦白的说,命名是一件困难的事情,要想出三个 恰到好处的命名不到一番功夫,尤其亲戚亲戚有些人的母语还都是编程语言所通用的英语。不过你是什么切都是值得了,好的命名只是你的代码更直观,更有表达力。

好的命名应该有下面的特性:

1.1 名副觉得

好的变量名告诉你:是哪几种东西,为哪几种处于,该为什么使用

是因为不到通过注释来解释变量,这麼 就先得不这麼 名副觉得了。

下面是书中的三个 示例代码,展示了命名对代码质量的提升

# bad code
def getItem(theList):
   ret = []
   for x in theList:
      if x[0] == 4:
         ret.append(x)
   return ret

# good code
def getFlaggedCell(gameBoard):
   '''扫雷游戏,flagged: 翻转'''
   flaggedCells = []
   for cell in gameBoard:
      if cell.IsFlagged():
         flaggedCells.append(cell)
   return flaggedCells

1.2 处置误导

  • 从不挂羊头卖狗肉
  • 从不覆盖惯用缩略语

这里不得不吐槽前7天 才看完的一份代码,岂都是使用了 l 作为变量名;只是,user岂都是是三个 list(单复数都没学些!!)

1.3 有意义的区分

代码是写给机器执行,也是给人阅读的,什么都有概念一定要有区分度。

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

是因为名称读不出来,这麼 讨论的时候就会像个傻鸟

1.5 使用方便搜索的命名

名字长短应与其作用域大小相对应

1.6 处置思维映射

比如在代码中写三个 temp,这麼 读者就得每次看完你是什么单词的时候翻译成其真正的意义

有表达力的代码是不需要注释的:The proper use of comments is to compensate for our failure to express ourself in code.

注释的适当作用在于弥补亲戚亲戚有些人用代码表达意图时遇到的失败,这听起来只是你懊丧,但事实觉得这麼 。The truth is in the code, 注释只是二手信息,二者的不同步是因为不等价是注释的最大大大问题。

书中给出了三个 非常形象的例子来展示:用代码来阐述,而非注释

bad
// check to see if the employee is eligible for full benefit
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

good
if (employee.isEligibleForFullBenefits())

只是,当我不需要去掉 注释的时候,还能否 想想有无还能否 通过修改命名,是因为修改函数(代码)的抽象层级来展示代码的意图。

当然,只是能因噎废食,书中指出了以下有些状况属于好的注释

  • 法务信息
  • 对意图的注释,为哪几种要这麼 做
  • 警示
  • TODO注释
  • 放大看似不合理之物的重要性

其中当时人最赞同的是第2点和第5点,做哪几种很容易通过命名表达,但为哪几种要这麼 做则从不直观,有点儿涉及到专业知识、算法的时候。另外,有些第一感觉“不这麼 优雅”的代码,他说有其特殊我不需要,这麼 曾经的代码就应该去掉 注释,说明为哪几种要曾经,比如为了提升关键路径的性能,是因为会牺牲部分代码的可读性。

最坏的注释只是过时是因为错误的注释,这对于代码的维护者(他说只是几个 月后的当时人)是巨大的伤害,可惜除了code review,并这麼 简单易行的办法来保证代码与注释的同步。

3.1 函数的单一职责

三个 函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断办法很简单:看看函数有无还能再拆出三个 函数。

函数要么做哪几种do_sth, 要么查询哪几种query_sth。最恶心的只是函数名表示只会query_sth, 但事实上却会do_sth, 这使得函数产生了副作用。比如书中的例子

public class UserValidator {
    private Cryptographer cryptographer;
    public boolean checkPassword(String userName, String password) {
        User user = UserGateway.findByName(userName);
        if (user != User.NULL) {
            String codedPhrase = user.getPhraseEncodedByPassword();
            String phrase = cryptographer.decrypt(codedPhrase, password);
            if ("Valid Password".equals(phrase)) {
                Session.initialize();
                return true;
            }
        }
        return false;
    }
}

3.2 函数的抽象层级

每个函数三个 抽象层次,函数中的搞笑的话都是在同三个 抽象层级,不同的抽象层级不到倒入同去。比如亲戚亲戚有些人想把大象倒入冰箱,应该是你是什么样子的:

def pushElephantIntoRefrige():
    openRefrige()
    pushElephant()
    closeRefrige()

函数后面 的三句代码在同三个 层级(宽度)描述了要完成把大象倒入冰箱这件事顺序相关的三个 步骤。显然,pushElephant你是什么步骤又是因为蕴含 什么都有子步骤,只是在pushElephantIntoRefrige你是什么层级,是不需要知道太久细节的。

当亲戚亲戚有些人想通过阅读代码的办法来了解三个 新的项目时,一般都是采取广度优先的策略,自上而下的阅读代码,先了解整体特性,只是再深入感兴趣的细节。是因为这麼 对实现细节进行良好的抽象(并凝练出三个 名副觉得的函数),这麼 阅读者就容易迷失在细节的汪洋里。

一种 程度看来,你是什么跟金字塔原理也很像

每三个 层级都是为了论证其上一层级的观点,同去只是到下一层级的支持;同一层级之间的多个论点又不到以一种 逻辑关系排序。pushElephantIntoRefrige只是中心论点,不到多个子步骤的支持,同去哪几种子步骤之间都是逻辑先后顺序。

3.3 函数参数

函数的参数太久,组合出的输入状况就愈多,不到的测试用例也就太久,也就越容易出大大问题。

输出参数相比返回值难以理解,这点深有同感,输出参数觉得是很不直观。从函数调用者的宽度,一眼就能看出返回值,而没能识别输出参数。输出参数通常逼迫调用者去检查函数签名,你是什么觉得不友好。

向函数传入Boolean(书中称之为 Flag Argument)通常都是好主意。尤其是传入True or False后的行为并都是一件事情的两面,只是两件不同的事情时。这很明显违背了函数的单一职责约束,处置办法很简单,那只是用三个 函数。

3.4 Dont repear yourself

在函数你是什么层级,是最容易、最直观实现复用的,什么都有IDE也难帮助亲戚亲戚有些人讲一段代码重构出三个 函数。

不过在实践中,也会老出曾经一种 状况:一段代码在多个办法中都是使用,只是又不完整版一样,是因为抽象成三个 通用函数,这麼 就不到加参数、加if else区别。曾经都是点尴尬,貌似还能否 重构,但又都是很完美。

造成上述大大问题的一种 状况是因为,这段代码也违背了单一职责原则,做了不只一件事情,这才是因为不好复用,处置办法是进行办法的细分,有助更好复用。也还能否 考虑template method来处置差异的部分。

非常惭愧的是,在我经历的项目中,测试(尤其是单元测试)老要都这麼 得到足够的重视,也这麼 试行过TDD。正是因为缺失,才更感良好测试的珍贵。

亲戚亲戚有些人常说,好的代码不到有可读性、可维护性、可扩展性,好的代码、架构不到不停的重构、迭代,但自动化测试是保证你是什么切的基础,这麼 高覆盖率的、自动化的单元测试、回归测试,谁都是敢去修改代码,不到任其腐烂。

即使针对核心模块写了单元测试,一般也很随意,认为这只是测试代码,配不上生产代码的地位,以为只是我能跑通就行了。这就是因为测试代码的可读性、可维护性非常差,只是是因为测试代码没能跟随生产代码同去更新、演化,最后是因为测试代码失效。什么都有说,脏测试 - 等同于 - 没测试。

只是,测试代码的三部分:可读性,可读性,可读性。

对于测试的原则、准则如下:

  • You are not allowed to write any production code unless it is to make a failing unit test pass. 这麼 测试时候从不写任何功能代码
  • You are not allowed to write any more of a unit test than is sufficient to fail; and compilation failures are failures. 只编写恰好有助体现三个 失败状况的测试代码
  • You are not allowed to write any more production code than is sufficient to pass the one failing unit test. 只编写恰好能通过测试的功能代码

测试的FIRST准则:

  • 快速(Fast)测试应该够快,尽量自动化。
  • 独立(Independent) 测试应该应该独立。从不相互依赖
  • 可重复(Repeatable) 测试应该在任何环境上都能重复通过。
  • 自我验证(Self-Validating) 测试应该有bool输出。从不通过查看日志你是什么低传输速率办法来判断测试有无通过
  • 及时(Timely) 测试应该及时编写,在其对应的生产代码时候编写

猜你喜欢

开源轻量级论坛 UseBB 安装图文教程

UseBB1.x最低运行环境要求为:PHP4.3.0、mysql3.23,一起去才能支持到PHP5.3和MySQL5.5,安装前请确认环境算不算达到最低要求。首先从本站下载Us

2020-02-19

老闆娘撐警 小店遭惡整 「選反對派將一片黑暗」

圖:李凱瑚擔心肯能由泛暴派主導香港社會及議會,香港將一片黑暗在鯉魚門經營銀龍咖啡茶座的老闆娘李凱瑚,因為撐警遭暴徒在網上發放惡意差評,暴徒又向政府部門作出無根據的投訴,她更曾一

2020-02-19

phpMyAdmin |phpMyAdmin v3.5.2.2 For Linux下载

下载首页最近更新下载排行软件分类源码报导模板下载网站资源论坛Asp源码.net源码PHP源码其它源码书籍教程服务器类网络软件应用软件系统工具图形图像多媒体类安全相关发布软件/源

2020-02-19

每天有10000+人教我写文章

张小龙那我说过,每天有十亿人教我做产品。当然我和张小龙之间还差了十万八千里,但每天也有一万人读我的文章。在这些 万的读者中,亲戚亲戚朋友来自不同的地方,有着不同的信念,有着不

2020-02-19

克雷塔罗VS内卡萨免费视频直播,克雷塔罗VS内卡萨比赛集锦,克雷塔罗VS内卡萨录像,克雷塔罗VS内卡萨首发阵容

首页新闻视频直播数据APP懂球号直播君广告合作协议协议克雷塔罗12-0111:05墨超2-3已现在现在开始了了内卡萨直播君|分析|集锦暂无数据近期比赛阿森纳英超4-0纽卡斯尔联

2020-02-18