代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:2
  • 来源:大发快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 出理 误导

  • 固然挂羊头卖狗肉
  • 固然覆盖惯用缩略语

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