代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:1
  • 来源:大发快3_快3注册网址_大发快3注册网址

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