代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:1

写出整洁的代码,是每个程序员的追求。《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) 测试应该及时编写,在其对应的生产代码完后 编写