代码整洁 vs 代码肮脏

  • 时间:
  • 浏览:5
  • 来源:大发uu快3_uu快3开奖历史_大发uu快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) 测试应该及时编写,在其对应的生产代码以前编写

猜你喜欢

Luis Mesero数据,Luis Mesero新闻,Luis Mesero视频,Luis Mesero身价

首页新闻视频直播数据APP懂球号直播君广告商务商务合作LuisMeseroLuisMesero俱乐部:国籍:西班牙身高:CM位置:球员年龄:体重:KG号码:号生日:惯用脚:比赛

2020-01-25

惠普 2570p(i5 3320M)图片,高清细节图,惠普 2570p(i5 3320M)图片大全

关于亲戚亲戚亲戚亲戚朋友|广告服务|使用条款|联系亲戚亲戚亲戚亲戚朋友北京盛拓优讯信息技术有限公司.版权所有中华人民共和国增值电信业务经营许可证编号:京B2-20170206北

2020-01-25

今天是3月22日世界水日:节约用水,点滴做起

IT之家3月22日消息 为了唤起公众的水意识,建立两种生活更为全面的水资源可持续利用的体制和相应的运行机制,1993年1月18日,第47届联合国大会根据联合国环境与发展大会制定

2020-01-25

开豪车撒欢?600年的故宫被“特权”送上热搜!

2020年,是紫禁城建成300周年,也是故宫博物院成立95周年,见证六百个峥嵘時光里流转,沉淀六百个寒来暑往。当历史与当下瞬间重合,峥嵘時光里安澜,宫阙巍峨,将所僵化 幽深有

2020-01-25

没三摄就落伍了!vivo Z5评测:千元机性价比就该这么玩

没三摄就落伍了!vivoZ5评测:千元机性价比就该那末玩出处:快科技2019-07-3120:34:11    作者:墨翟编辑:墨翟[爆料]收藏文章一、前言:代代爆款vivoZ

2020-01-24