代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0

写出整洁的代码,是每个线程池池员的追求。《clean code》指出,要想写出好的代码,首先得知道有哪些是肮脏代码、有哪些是整洁代码;這個 通过血块的刻意练习,不还可不可不后能 真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了大家 是糟糕代码的受害者。国内有有3个多多更适合的词汇:屎山,嘴笨 一定会很文雅這個 更加客观,线程池池员既是受害者也是加害者。

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

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

其中,我最喜欢的是表达力(Expressiveness)這個 描述,這個 词似乎道出了好代码的真谛:用简单直接的最好的办法描绘出代码的功能,越多也不 少。

本文记录阅读《clean code》随后每各自 所有“深有同感”导致 分析“醍醐灌顶”的這個 观点。

坦白的说,命名是一件困难的事情,要想出有3个多多恰到好处的命名时要一番功夫,尤其大家 的母语还一定会编程语言所通用的英语。不过這個 切一定会值得了,好的命名這個 你的代码更直观,更有表达力。

好的命名应该有下面的形状:

1.1 名副嘴笨

好的变量名告诉你:是有哪些东西,为有哪些指在,该为什么会么会会 使用

导致 分析时要通过注释来解释变量,这麼就先得不这麼名副嘴笨 了。

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

# 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你以为是有3个多多list(单复数都没学是!!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

导致 分析名称读没得来,这麼讨论的随后就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 出理 思维映射

比如在代码中写有3个多多temp,这麼读者就得每次看一遍這個 单词的随后翻译成其真正的意义

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

注释的适当作用在于弥补大家 用代码表达意图时遇到的失败,这听起来這個 你烦闷,但事实嘴笨 这麼。The truth is in the code, 注释也不 二手信息,二者的不同步导致 分析不等价是注释的最大问题报告 。

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

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点,做有哪些很容易通过命名表达,但为有哪些要这麼做则越多直观,很糙涉及到专业知识、算法的随后。另外,這個 第一感觉“不这麼优雅”的代码,你说有其特殊你还可不可不后能 ,这麼原来的代码就应该添加注释,说明为有哪些要原来,比如为了提升关键路径的性能,导致 分析会牺牲要素代码的可读性。

最坏的注释也不 过时导致 分析错误的注释,这对于代码的维护者(你说也不 2个月后的每各自 所有)是巨大的伤害,可惜除了code review,并这麼简单易行的最好的办法来保证代码与注释的同步。

3.1 函数的单一职责

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

函数要么做有哪些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 函数的抽象层级

每个函数有3个多多抽象层次,函数中的句子一定会在同有3个多多抽象层级,不同的抽象层级只有放上去一同。比如大家 想把大象放上去冰箱,应该是這個 样子的:

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

函数后面 的三句代码在同有3个多多层级(层厚)描述了要完成把大象放上去冰箱这件事顺序相关的有3个多多步骤。显然,pushElephant這個 步骤又导致 分析蕴藏好多好多 子步骤,這個 在pushElephantIntoRefrige這個 层级,是不必知道越多细节的。

当大家 想通过阅读代码的最好的办法来了解有3个多多新的项目时,一般一定会采取广度优先的策略,自上而下的阅读代码,先了解整体形状,這個 再深入感兴趣的细节。导致 分析这麼对实现细节进行良好的抽象(并凝练出有3个多多名副嘴笨 的函数),这麼阅读者就容易迷失在细节的汪洋里。

三种生活程度看来,這個 跟金字塔原理也很像

每有3个多多层级一定会为了论证其上一层级的观点,一同也时要下一层级的支持;同一层级之间的多个论点又时要以三种生活逻辑关系排序。pushElephantIntoRefrige也不 中心论点,时要多个子步骤的支持,一同有有哪些子步骤之间一定会逻辑先后顺序。

3.3 函数参数

函数的参数越多,组合出的输入情形就愈多,时要的测试用例也就越多,也就越容易出问题报告 。

输出参数相比返回值难以理解,这点深有同感,输出参数嘴笨 是很不直观。从函数调用者的层厚,一眼就能看出返回值,而不难 识别输出参数。输出参数通常逼迫调用者去检查函数签名,這個 嘴笨 不友好。

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

3.4 Dont repear yourself

在函数這個 层级,是最容易、最直观实现复用的,好多好多 IDE也难帮助大家 讲一段代码重构出有3个多多函数。

不过在实践中,也会经常出现原来三种生活情形:一段代码在多个最好的办法中一定会使用,這個 又不完全一样,导致 分析抽象成有3个多多通用函数,这麼就时要加参数、加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. 只编写恰好不必还可不可不后能 体现有3个多多失败情形的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码随后编写