代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:0
  • 来源:大发快三_快三交流群_大发快三交流群

写出整洁的代码,是每个守护tcp连接员的追求。《clean code》指出,要想写出好的代码,首先得知道你这个 是肮脏代码、你这个 是整洁代码;或者通过几瓶的刻意练习,不能真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了朋友 是糟糕代码的受害者。国内有从前更适合的词汇:屎山,实在全是很文雅或者更加客观,守护tcp连接员既是受害者也是加害者。

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

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

其中,我最喜欢的是表达力(Expressiveness)你这个 描述,你这个 词似乎道出了好代码的真谛:用简单直接的最好的土法律法律依据描绘出代码的功能,太多可是我 少。

本文记录阅读《clean code》从前当事人“深有同感”可能“醍醐灌顶”的太多太多观点。

坦白的说,命名是一件困难的事情,要想出从前恰到好处的命名里后能 一番功夫,尤其朋友 的母语还全是编程语言所通用的英语。不过你这个 切全是值得了,好的命名要我的代码更直观,更有表达力。

好的命名应该有下面的社会形态:

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 正确处理误导

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

这里不得不吐槽前5天才看过的一份代码,简直使用了 l 作为变量名;或者,user简直是从前list(单复数都没专学 !!)

1.3 有意义的区分

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

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

1.4 使用读的出来的单词

可能名称读如此来,如此讨论的从前就会像个傻鸟

1.5 使用方便搜索的命名

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

1.6 正确处理思维映射

比如在代码中写从前temp,如此读者就得每次看过你这个 单词的从前翻译成其真正的意义

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

注释的适当作用在于弥补朋友 用代码表达意图时遇到的失败,这听起来要我郁闷,但事实实在如此。The truth is in the code, 注释可是我 二手信息,二者的不同步可能不等价是注释的最问提图片图片。

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

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

从前函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断最好的土法律法律依据很简单:看看函数是否还能再拆出从前函数。

函数要么做你这个 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 函数的抽象层级

每个函数从前抽象层次,函数中的得话全是在同从前抽象层级,不同的抽象层级后能 倒进一并。比如朋友 想把大象倒进冰箱,应该是你这个 样子的:

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

函数里面的三句代码在同从前层级(层厚)描述了要完成把大象倒进冰箱这件事顺序相关的从前步骤。显然,pushElephant你这个 步骤又可能中含 太多太多子步骤,或者在pushElephantIntoRefrige你这个 层级,是太多再知道太多细节的。

当朋友 想通过阅读代码的最好的土法律法律依据来了解从前新的项目时,一般全是采取广度优先的策略,自上而下的阅读代码,先了解整体社会形态,或者再深入感兴趣的细节。可能如此对实现细节进行良好的抽象(并凝练出从前名副实在的函数),如此阅读者就容易迷失在细节的汪洋里。

某种程度看来,你这个 跟金字塔原理也很像

每从前层级全是为了论证其上一层级的观点,一并也里后能 下一层级的支持;同一层级之间的多个论点又里后能 以某种逻辑关系排序。pushElephantIntoRefrige可是我 中心论点,里后能 多个子步骤的支持,一并你这个 子步骤之间全是逻辑先后顺序。

3.3 函数参数

函数的参数太多,组合出的输入状态就愈多,里后能 的测试用例也就太多,也就越容易出问提图片。

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

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

3.4 Dont repear yourself

在函数你这个 层级,是最容易、最直观实现复用的,太多太多IDE也难帮助朋友 讲一段代码重构出从前函数。

不过在实践中,也会出現从前某种状态:一段代码在多个最好的土法律法律依据中全是使用,或者又不完整版一样,可能抽象成从前通用函数,如此就里后能 加参数、加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. 只编写恰好不能体现从前失败状态的测试代码
  • 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) 测试应该及时编写,在其对应的生产代码从前编写