代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:极速快3_快3计划三期必中_极速快3计划三期必中

写出整洁的代码,是每个tcp连接员的追求。《clean code》指出,要想写出好的代码,首先得知道有哪些是肮脏代码、有哪些是整洁代码;或者通过少量的刻意练习,不必 真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了大家是糟糕代码的受害者。国内1个多更适合的词汇:屎山,虽或者会很文雅或者更加客观,tcp连接员既是受害者也是加害者。

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

  • 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) 测试应该及时编写,在其对应的生产代码如果编写