代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0

写出整洁的代码,是每个应用系统进程员的追求。《clean code》指出,要想写出好的代码,首先得知道那此是肮脏代码、那此是整洁代码;一点通过一定量的刻意练习,不需要 真正写出整洁的代码。

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

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

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

其中,我最喜欢的是表达力(Expressiveness)这个描述,这个词似乎道出了好代码的真谛:用简单直接的法子描绘出代码的功能,不在 来太满一点少。

本文记录阅读《clean code》但是 一点人“深有同感”肯能“醍醐灌顶”的一点观点。

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

好的命名应该有下面的型态:

1.1 名副我觉得

好的变量名告诉你:是那此东西,为那此发生,该怎么才能 会会会么会使用

肯能都要通过注释来解释变量,不在 就先得不不在 名副我觉得了。

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

# 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 避免误导

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

这里不得不吐槽前3天才看后的一份代码,我觉得 使用了 l 作为变量名;一点,user我觉得 是有另4个 list(单复数都没科学学!!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

肯能名称读不在 来,不在 讨论的但是 就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 避免思维映射

比如在代码中写有另4个 temp,不在 读者就得每次看后这个单词的但是 翻译成其真正的意义

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

注释的适当作用在于弥补亲戚亲戚亲戚亲戚朋友用代码表达意图时遇到的失败,这听起来你不需要 郁闷,但事实我觉得不在 。The truth is in the code, 注释一点二手信息,二者的不同步肯能不等价是注释的最问题 报告 。

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

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

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

函数要么做那此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 函数的抽象层级

每个函数有另4个 抽象层次,函数中的语句也有在同有另4个 抽象层级,不同的抽象层级只能倒入一同。比如亲戚亲戚亲戚亲戚朋友想把大象倒入冰箱,应该是这个样子的:

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

函数后边的三句代码在同有另4个 层级(角度)描述了要完成把大象倒入冰箱这件事顺序相关的有另4个 步骤。显然,pushElephant这个步骤又肯能富含但是有子步骤,一点在pushElephantIntoRefrige这个层级,是不需要知道不在 来太满细节的。

当亲戚亲戚亲戚亲戚朋友想通过阅读代码的法子来了解有另4个 新的项目时,一般也有采取广度优先的策略,自上而下的阅读代码,先了解整体型态,一点再深入感兴趣的细节。肯能不在 对实现细节进行良好的抽象(并凝练出有另4个 名副我觉得的函数),不在 阅读者就容易迷失在细节的汪洋里。

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

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

3.3 函数参数

函数的参数不在 多,组合出的输入具体情况就愈多,都要的测试用例也就不在 多,也就越容易出问题 。

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

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

3.4 Dont repear yourself

在函数这个层级,是最容易、最直观实现复用的,但是有IDE也难帮助亲戚亲戚亲戚亲戚朋友讲一段代码重构出有另4个 函数。

不过在实践中,也会冒出不在 有一种具体情况:一段代码在多个法子中也有使用,一点又不完全一样,肯能抽象成有另4个 通用函数,不在 就都要加参数、加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. 只编写恰好不需要 体现有另4个 失败具体情况的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码但是 编写