代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0

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