代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:3分时时彩官网_3分时时彩投注平台注册_3分时时彩下注平台注册

写出整洁的代码,是每个系统守护进程员的追求。《clean code》指出,要想写出好的代码,首先得知道哪几可是我肮脏代码、哪几可是我整洁代码;可是我通过血块的刻意练习,都能不能真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了.我歌词 是糟糕代码的受害者。国内4个更适合的词汇:屎山,真是后要 很文雅可是我更加客观,系统守护进程员既是受害者也是加害者。

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

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

其中,我最喜欢的是表达力(Expressiveness)什儿 描述,什儿 词似乎道出了好代码的真谛:用简单直接的妙招 描绘出代码的功能,太满可是我我 我少。

本文记录阅读《clean code》可是我或多或少人“深有同感”可能性“醍醐灌顶”的或多或少观点。

坦白的说,命名是一件困难的事情,要想出4个恰到好处的命名需要一番功夫,尤其.我歌词 的母语还后要 编程语言所通用的英语。不过什儿 切后要 值得了,好的命名让他的代码更直观,更有表达力。

好的命名应该有下面的行态:

1.1 名副真是

好的变量名告诉你:是哪几只东西,为哪几只处在,该为啥会 使用

可能性需要通过注释来解释变量,越来越 就先得不越来越 名副真是了。

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

# 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果果真4个list(单复数都没学得!!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

可能性名称读没得来,越来越 讨论的可是我就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 正确处理思维映射

比如在代码中写4个temp,越来越 读者就得每次看后什儿 单词的可是我翻译成其真正的意义

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

注释的适当作用在于弥补.我歌词 用代码表达意图时遇到的失败,这听起来让他郁闷,但事实真是越来越 。The truth is in the code, 注释可是我我 我二手信息,二者的不同步可能性不等价是注释的最问题。

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

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

4个函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断妙招 很简单:看看函数否是还能再拆出4个函数。

函数要么做哪几只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 函数的抽象层级

每个函数4个抽象层次,函数中的的话后要 在同4个抽象层级,不同的抽象层级越来越 里装一起。比如.我歌词 想把大象里装冰箱,应该是什儿 样子的:

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

函数上方的三句代码在同4个层级(厚度)描述了要完成把大象里装冰箱这件事顺序相关的4个步骤。显然,pushElephant什儿 步骤又可能性含有可是我我 子步骤,可是我在pushElephantIntoRefrige什儿 层级,是太满再知道太满细节的。

.我歌词 歌词 想通过阅读代码的妙招 来了解4个新的项目时,一般后要 采取广度优先的策略,自上而下的阅读代码,先了解整体行态,可是我再深入感兴趣的细节。可能性越来越 对实现细节进行良好的抽象(并凝练出4个名副真是的函数),越来越 阅读者就容易迷失在细节的汪洋里。

两种程度看来,什儿 跟金字塔原理也很像

每4个层级后要 为了论证其上一层级的观点,一起也需要下一层级的支持;同一层级之间的多个论点又需要以两种逻辑关系排序。pushElephantIntoRefrige可是我我 我中心论点,需要多个子步骤的支持,一起哪几只子步骤之间后要 逻辑先后顺序。

3.3 函数参数

函数的参数太满,组合出的输入情况就愈多,需要的测试用例也就太满,也就越容易再次出问题。

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

向函数传入Boolean(书中称之为 Flag Argument)通常后要 好主意。尤其是传入True or False后的行为并后要 一件事情的两面,可是我我 我两件不同的事情时。这很明显违背了函数的单一职责约束,正确处理妙招 很简单,那可是我我 我用4个函数。

3.4 Dont repear yourself

在函数什儿 层级,是最容易、最直观实现复用的,可是我我 IDE也难帮助.我歌词 讲一段代码重构出4个函数。

不过在实践中,也会再次出现从前 两种情况:一段代码在多个妙招 中后要 使用,可是我又不全部一样,可能性抽象成4个通用函数,越来越 就需要加参数、加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. 只编写恰好都能不能体现4个失败情况的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码可是我编写