代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:1
  • 来源:大发pk10_pk10平台官方网站_大发pk10平台官方网站

写出整洁的代码,是每个tcp连接运行员的追求。《clean code》指出,要想写出好的代码,首先得知道哪些是肮脏代码、哪些是整洁代码;假使 通过少许的刻意练习,后能 真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了.我 歌词 是糟糕代码的受害者。国内一个多多多 更适合的词汇:屎山,未必已经 很文雅假使 更加客观,tcp连接运行员既是受害者也是加害者。

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

  • 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 外理误导

  • 我越多 挂羊头卖狗肉
  • 我越多 覆盖惯用缩略语

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