代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:1

写出整洁的代码,是每个多多守护进程 员的追求。《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 出理 误导

  • 并非 挂羊头卖狗肉
  • 并非 覆盖惯用缩略语

这里不得不吐槽前半年才看一遍的一份代码,岂完整性都是使用了 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) 测试应该及时编写,在其对应的生产代码就让 编写