代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:大发快三_快三下载安装_大发快三下载安装

写出整洁的代码,是每个系统进程员的追求。《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 解决误导

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

这里不得不吐槽前5天才看得人的一份代码,果然使用了 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) 测试应该及时编写,在其对应的生产代码很久 编写