代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:2
  • 来源:3分时时彩官网_去哪玩3分时时彩_哪里可以玩3分时时彩

写出整洁的代码,是每个系统系统进程员的追求。《clean code》指出,要想写出好的代码,首先得知道那此是肮脏代码、那此是整洁代码;因此通太久量的刻意练习,不可不后能 真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了亲戚亲戚大家是糟糕代码的受害者。国内有有1个更适合的词汇:屎山,确实都不 很文雅因此更加客观,系统系统进程员既是受害者也是加害者。

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

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

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

本文记录阅读《clean code》完后 被委托人“深有同感”因此“醍醐灌顶”的一点观点。

坦白的说,命名是一件困难的事情,要想出有1个恰到好处的命名时需一番功夫,尤其亲戚亲戚大家的母语还都不 编程语言所通用的英语。不过一点切都不 值得了,好的命名你能不可不后能 的代码更直观,更有表达力。

好的命名应该有下面的社会形态:

1.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 处里误导

  • 太久挂羊头卖狗肉
  • 太久覆盖惯用缩略语

这里不得不吐槽前半年才看过的一份代码,青春恋爱物语使用了 l 作为变量名;因此,user青春恋爱物语是有1个list(单复数都不能自己 学!!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

因此名称读都这麼来,不能自己 讨论的完后 就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 处里思维映射

比如在代码中写有1个temp,不能自己 读者就得每次看过一点单词的完后 翻译成其真正的意义

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

注释的适当作用在于弥补亲戚亲戚大家用代码表达意图时遇到的失败,这听起来你能不可不后能 心烦,但事实确实不能自己 。The truth is in the code, 注释什么都有有我二手信息,二者的不同步因此不等价是注释的最大那此的现象。

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

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 函数的单一职责

有1个函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断土辦法 很简单:看看函数是不是还能再拆出有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 函数的抽象层级

每个函数有1个抽象层次,函数中的一段话都不 在同有1个抽象层级,不同的抽象层级不能自己 倒入共同。比如亲戚亲戚大家想把大象倒入冰箱,应该是一点样子的:

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

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

当亲戚亲戚大家想通过阅读代码的土辦法 来了解有1个新的项目时,一般都不 采取广度优先的策略,自上而下的阅读代码,先了解整体社会形态,因此再深入感兴趣的细节。因此不能自己 对实现细节进行良好的抽象(并凝练出有1个名副确实的函数),不能自己 阅读者就容易迷失在细节的汪洋里。

一种程度看来,一点跟金字塔原理也很像

每有1个层级都不 为了论证其上一层级的观点,共同也时需下一层级的支持;同一层级之间的多个论点又时需以一种逻辑关系排序。pushElephantIntoRefrige什么都有有我中心论点,时需多个子步骤的支持,共同那此子步骤之间都不 逻辑先后顺序。

3.3 函数参数

函数的参数太久,组合出的输入情況就愈多,时需的测试用例也就太久,也就越容易出那此的现象。

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

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

3.4 Dont repear yourself

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

不过在实践中,也会再次出现什么都有有我一种情況:一段代码在多个土辦法 中都不 使用,因此又不全版一样,因此抽象成有1个通用函数,不能自己 就时需加参数、加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. 只编写恰好不不可不后能 体现有1个失败情況的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码完后 编写