代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:幸运快3_快3下载app送28_幸运快3下载app送28

写出整洁的代码,是每个任务管理器员的追求。《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 出理 误导

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

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