代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:幸运快3_快3口诀_幸运快3口诀

写出整洁的代码,是每个系统进程员的追求。《clean code》指出,要想写出好的代码,首先得知道有哪些是肮脏代码、有哪些是整洁代码;之前 通过几滴 的刻意练习,助于真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了当让我们是糟糕代码的受害者。国内有有1个更适合的词汇:屎山,其实都会很文雅之前 更加客观,系统进程员既是受害者也是加害者。

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

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

其中,我最喜欢的是表达力(Expressiveness)一些描述,一些词似乎道出了好代码的真谛:用简单直接的方式描绘出代码的功能,太久之前 少。

本文记录阅读《clean code》之前 此人 “深有同感”肯能“醍醐灌顶”的一些观点。

坦白的说,命名是一件困难的事情,要想出有1个恰到好处的命名这么一番功夫,尤其当让我们的母语还都会编程语言所通用的英语。不过一些切都会值得了,好的命名我能 的代码更直观,更有表达力。

好的命名应该有下面的外部:

1.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 避免误导

  • 并不一定挂羊头卖狗肉
  • 并不一定覆盖惯用缩略语

这里不得不吐槽前4天 才想看 的一份代码,居然使用了 l 作为变量名;之前 ,user居然是有1个list(单复数都这么学 !!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

肯能名称读不出来,这么讨论的之前 就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 避免思维映射

比如在代码中写有1个temp,这么读者就得每次想看 一些单词的之前 翻译成其真正的意义

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

注释的适当作用在于弥补当让我们用代码表达意图时遇到的失败,这听起来我能 气愤,但事实其实这么。The truth is in the code, 注释之前 二手信息,二者的不同步肯能不等价是注释的最大有哪些的问题。

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

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 函数的单一职责

有1个函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断方式很简单:看看函数与非 还能再拆出有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 函数的抽象层级

每个函数有1个抽象层次,函数中的的话都会在同有1个抽象层级,不同的抽象层级这么放上一块儿。比如当让我们想把大象放上冰箱,应该是一些样子的:

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

函数上端的三句代码在同有1个层级(深层)描述了要完成把大象放上冰箱这件事顺序相关的有1个步骤。显然,pushElephant一些步骤又肯能暗含全都子步骤,之前 在pushElephantIntoRefrige一些层级,是不想知道太久细节的。

当当让我们想通过阅读代码的方式来了解有1个新的项目时,一般都会采取广度优先的策略,自上而下的阅读代码,先了解整体外部,之前 再深入感兴趣的细节。肯能这么对实现细节进行良好的抽象(并凝练出有1个名副其实的函数),这么阅读者就容易迷失在细节的汪洋里。

四种 程度看来,一些跟金字塔原理也很像

每有1个层级都会为了论证其上一层级的观点,一块儿也这么下一层级的支持;同一层级之间的多个论点又这么以四种 逻辑关系排序。pushElephantIntoRefrige之前 中心论点,这么多个子步骤的支持,一块儿有有哪些子步骤之间都会逻辑先后顺序。

3.3 函数参数

函数的参数太久,组合出的输入具体情况就愈多,这么的测试用例也就太久,也就越容易出有哪些的问题。

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

向函数传入Boolean(书中称之为 Flag Argument)通常都会好主意。尤其是传入True or False后的行为并都会一件事情的两面,之前 两件不同的事情时。这很明显违背了函数的单一职责约束,避免方式很简单,那之前 用有1个函数。

3.4 Dont repear yourself

在函数一些层级,是最容易、最直观实现复用的,全都IDE也难帮助当让我们讲一段代码重构出有1个函数。

不过在实践中,也会再次出现这么 四种 具体情况:一段代码在多个方式中都会使用,之前 又不完正一样,肯能抽象成有1个通用函数,这么就这么加参数、加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. 只编写恰好助于体现有1个失败具体情况的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码之前 编写