代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0

写出整洁的代码,是每个程序运行运行员的追求。《clean code》指出,要想写出好的代码,首先得知道那些是肮脏代码、那些是整洁代码;就说 通过絮状的刻意练习,并能真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了亲戚亲戚我们歌词 歌词 都都都 是糟糕代码的受害者。国内有另有好2个 更适合的词汇:屎山,虽然都有很文雅就说 更加客观,程序运行运行员既是受害者也是加害者。

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

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

其中,我最喜欢的是表达力(Expressiveness)你是什么描述,你是什么词似乎道出了好代码的真谛:用简单直接的最好的法子描绘出代码的功能,过多就说 少。

本文记录阅读《clean code》已经 一点人“深有同感”导致 着着“醍醐灌顶”的一点观点。

坦白的说,命名是一件困难的事情,要想出另有好2个 恰到好处的命名都要一番功夫,尤其亲戚亲戚我们歌词 歌词 都都都 的母语还都有编程语言所通用的英语。不过你是什么切都有值得了,好的命名让人的代码更直观,更有表达力。

好的命名应该有下面的底部形态:

1.1 名副虽然

好的变量名告诉你:是那些东西,为那些处于,该缘何使用

导致 着着都要通过注释来解释变量,越来越就先得不越来越名副虽然了。

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

# 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虽然 是另有好2个 list(单复数都越来越学!!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

导致 着着名称读越来越来,越来越讨论的已经 就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 避免思维映射

比如在代码中写另有好2个 temp,越来越读者就得每次看得人你是什么单词的已经 翻译成其真正的意义

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

注释的适当作用在于弥补亲戚亲戚我们歌词 歌词 都都都 用代码表达意图时遇到的失败,这听起来让人懊丧,但事实虽然越来越。The truth is in the code, 注释就说 二手信息,二者的不同步导致 着着不等价是注释的最问题。

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

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

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

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

每个函数另有好2个 抽象层次,函数中的一句话都有在同另有好2个 抽象层级,不同的抽象层级还并能了中放共同。比如亲戚亲戚我们歌词 歌词 都都都 想把大象中放冰箱,应该是你是什么样子的:

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

函数里面的三句代码在同另有好2个 层级(强度)描述了要完成把大象中放冰箱这件事顺序相关的另有好2个 步骤。显然,pushElephant你是什么步骤又导致 着着暗含就说 子步骤,就说 在pushElephantIntoRefrige你是什么层级,是不用知道过多细节的。

当亲戚亲戚我们歌词 歌词 都都都 想通过阅读代码的最好的法子来了解另有好2个 新的项目时,一般都有采取广度优先的策略,自上而下的阅读代码,先了解整体底部形态,就说 再深入感兴趣的细节。导致 着着越来越对实现细节进行良好的抽象(并凝练出另有好2个 名副虽然的函数),越来越阅读者就容易迷失在细节的汪洋里。

三种程度看来,你是什么跟金字塔原理也很像

每另有好2个 层级都有为了论证其上一层级的观点,共同也都要下一层级的支持;同一层级之间的多个论点又都要以三种逻辑关系排序。pushElephantIntoRefrige就说 中心论点,都要多个子步骤的支持,共同那些子步骤之间都有逻辑先后顺序。

3.3 函数参数

函数的参数过多,组合出的输入情况表就愈多,都要的测试用例也就过多,也就越容易出问题。

输出参数相比返回值难以理解,这点深有同感,输出参数虽然是很不直观。从函数调用者的强度,一眼就能看出返回值,而比较慢识别输出参数。输出参数通常逼迫调用者去检查函数签名,你是什么虽然不友好。

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

3.4 Dont repear yourself

在函数你是什么层级,是最容易、最直观实现复用的,就说 IDE也难帮助亲戚亲戚我们歌词 歌词 都都都 讲一段代码重构出另有好2个 函数。

不过在实践中,也会老会 出现就说 三种情况表:一段代码在多个最好的法子中都有使用,就说 又不完整一样,导致 着着抽象成另有好2个 通用函数,越来越就都要加参数、加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. 只编写恰好并能体现另有好2个 失败情况表的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码已经 编写