0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

详谈代码结构化的重要性和经验方法

如意 来源:读芯术 作者:读芯术 2020-07-05 10:25 次阅读

作为代码工作中至关重要的一环,代码结构化是颇具难度的。要想写出结构良好的代码,编写者需要具有正确的思维方式,对设计模式有自己的理解,还得拥有丰富经验。通常情况下,要想培养上述能力,你要走的路可不少。

代码结构化的重要性不应被低估,从可读性和可维护性的角度来看,代码结构非常重要。

经验1:提前设计

在着手编写代码之前,你最好考虑一下对将要构建的应用程序进行提前设计,统一建模图表(UML diagrams)就是个不错的选择。在编写代码之前,如果提前有计划在手,编写者可以更加专注。通过提前思考代码的结构,创建一些有用的UML图表,许多明显缺陷都可以提前避免。

更重要的是,制定计划能让我们认识到,在编写代码前还有许多需要编写者思考的事情。UML图还可以防止代码编写者“思想游离”,并且防止编写者在代码里添加自认为将来会派上用场的非必要功能。

不做计划就急着开始,在最初你能跑得快一点儿,但跳过这个步骤最终会使你不得不对大量代码进行重构,进而消耗大量时间和动力。记住,欲速则不达。

经验2:类与函数准则

以下准则可以帮助你保持类与函数的可读性及可维护性:

· 使类与函数尽可能地小

· 类与函数应遵循单一职责原则

保证类与函数尽可能小可以使代码更容易理解。一般来说,较大的类和函数应被分解为较小的专门化类别。

遵循单一责任原则可以帮助你保持类和函数在较小的级别,即每个类、每个函数只做一件事。但注意,要在合理范围内划分得“小”,因为多数情况下,过多的细小分类反而要比几个大类糟糕得多。把函数分成“获取、处理及存储数据”这样的大型函数是行不通的。你必须将此函数分成三个较小的函数:分别用于提取、处理和数据存储。

经验3:使用设计模式

了解设计模式及其工作方式可以帮助你编写出更加结构化、更具可读性与可维护性的代码。如果你清楚在哪些情况下可以使用哪种设计模式,就不必非得自己想解决办法了,你只需遵循设计原则就可以保持代码的整洁。

不过要注意,不要过度使用设计模式,这是使用这种方法时最常见的陷阱。尽管在特定情况下可以使用设计模式,但过度使用设计模式对编写者来说有弊无利,它会使应用过度机械化,其他开发人员会很难理解代码。

经验4:代码规范

代码结构化在很大程度上与代码规范有关。对于每个项目来说,代码规范都是必要,如果没有代码规范,代码变得团团乱以至难以阅读是迟早的事。

我们可以列出代码规范清单,记录下声明变量的方法、命名规范等。你可以无限向列表中添加规则,规则的数量也是可以变化的,只列出对你和对你的团队有帮助的规则便可。团队成员也可以随时向规范列表中添加或移除规则。

制定好规范清单后,就坚持照做吧!

经验5:编写单元测试

编写单元测试能产生不错的预期外的效果,它让你必须对代码进行结构化处理。为了能够编写出单元测试,至少要保证代码的结构是正确的。

也许你以前听说过或者编写过不可测试代码,如果有哪段代码让你不知道该如何编写单元测试的话,可能是因为这段代码功能过多,或者写得太差。

不管是上述两种情况的哪一种,只有一个原因会导致代码无法测试,那就是糟糕的结构。遇到不可测试的代码时,你会发现自己大部分时间都用在了重构上。单元测试便可以作为一种限制,使你必须将代码进行结构化处理。

实现代码结构化有好些方式。在你键入第一个代码字母之前就开始了,包括提前考虑应用程序的设计、创建帮助编写者消除明显缺陷的UML图等。

只要你准备编写代码,就应该确保拥有一份可以遵守的代码规范表。学习使用设计模式也可以进一步帮你实现这个目标。同时,你还需保持类与函数单位较小,并且让这些类与函数只做一件事。最后,要养成编写单元测试的习惯,不这样做最终只会得到一堆不可测试的代码。

要更认真地对待代码结构化了!

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 编程
    +关注

    关注

    88

    文章

    3649

    浏览量

    94345
  • 源代码
    +关注

    关注

    96

    文章

    2948

    浏览量

    67198
  • 结构化
    +关注

    关注

    0

    文章

    27

    浏览量

    10345
收藏 人收藏

    评论

    相关推荐

    结构化数据中台:企业AI应用安全落地的核心引擎

    在数字转型浪潮中,非结构化数据(如文档、图片、音视频等)已成为企业核心资产,其价值挖掘能力直接影响AI应用的效能与安全。然而,数据分散、多模态处理复杂、安全合规风险高等问题,严重制约了企业AI
    的头像 发表于 02-27 17:06 155次阅读

    选择正版SolidWorks的重要性及如何避免盗版风险

    ,还可能给用户带来潜在的风险。本文将探讨选择正版SolidWorks的重要性,并提供一些有效的方法来避免盗版风险。作为SolidWorks的官方授权代理商,亿达四方将为您提供专业的建议和支持。 选择正版SolidWorks的重要性
    的头像 发表于 12-02 18:00 988次阅读

    基于分布式对象存储WDS的信托非结构化数据整合平台

    基于分布式对象存储WDS的信托非结构化数据整合平台
    的头像 发表于 08-28 09:56 478次阅读
    基于分布式对象存储WDS的信托非<b class='flag-5'>结构化</b>数据整合平台

    关于蓄电池气密检测仪重要性和使用方法

    在能源存储领域,电池的性能和安全非常重要,气密作为衡量其质量的关键指标之一,直接影响电池的使用寿命、性能和安全。因此,蓄电池气密检测
    的头像 发表于 08-23 15:48 391次阅读
    关于蓄电池气密<b class='flag-5'>性</b>检测仪<b class='flag-5'>重要性</b>和使用<b class='flag-5'>方法</b>

    凯迪正大分享电缆交流电压检测的试验方法及其重要性

    电缆交流电压检测作为评估电缆工作状态、预防故障发生的重要方式之一,其试验方法的选择与执行至关重要。本文讲结合凯迪正大的实操经验探讨电缆交流电压检测的基本原理、常用试
    的头像 发表于 08-12 15:41 532次阅读

    凯迪正大对110kV电力电缆交接试验的重要性与实施方法简述

    确保其在实际运行中能够稳定可靠地工作,保障电网运行的安全和可靠。本文将从110kV电力电缆交接试验的重要性入手,按照武汉凯迪正大的实操经验简述其试验方法及实施过程。
    的头像 发表于 06-18 17:19 571次阅读
    凯迪正大对110kV电力电缆交接试验的<b class='flag-5'>重要性</b>与实施<b class='flag-5'>方法</b>简述

    定期维护结构化布线对于办公室得重要性

    定期维护结构化布线对于办公室的顺利运行至关重要结构化布线是指支持建筑物内各种数据、语音和视频系统的标准基础设施。它包括电缆、连接器、机架和其他构成网络主干的组件。 通过正确维护
    的头像 发表于 06-14 10:44 310次阅读

    求助,ADC接地的重要性

    ADC接地的重要性
    发表于 06-04 07:56

    露天矿边坡监测的重要性方法

    露天矿边坡监测的重要性方法
    的头像 发表于 05-28 16:24 584次阅读

    气密检测的重要性

    在现代工业生产和日常生活中,气密检测扮演着至关重要的角色。无论是在汽车、航空、医疗还是电子行业,确保产品或结构具有良好的气密性能对于保障其功能、安全和效率至关重要。气密
    的头像 发表于 04-26 11:51 1081次阅读
    气密<b class='flag-5'>性</b>检测的<b class='flag-5'>重要性</b>

    通过大小鼠无创血压测量实验明白了无创血压测量技术的重要性

    无创血压测量技术的重要性:无创血压测量技术是一种非侵入的测量方法,可以避免对动物造成不必要的伤害。在医学研究中,无创血压测量技术被广泛应用于各种疾病的诊断和治疗过程中,如高血压、心脏病等。因此
    发表于 04-22 09:40

    什么是结构化网络布线?结构化网络布线有哪些好处?

    EIA/TIA TR42 委员会指定的通信布线的标准架构和组件,并被制造商用作确保互操作的自愿标准。 如果你查看 TIA TR42,可能会发现 TIA 568 在技术上对结构化布线进行了更加详细的定义和概述,但你可能会遇到
    的头像 发表于 04-11 11:54 651次阅读

    结构化布线的好处多吗

    结构化布线是网络系统中的重要组成部分,因为它为数据传输提供了强大、可扩展且可靠的基础。通过遵守全球公认的标准,结构化布线可促进高速连接、简化故障排除并确保未来的可扩展性。考虑到这些优势,企业应优先
    的头像 发表于 04-07 11:15 542次阅读

    什么是网络系统中的结构化布线?

    。 什么是结构化布线? 结构化布线是指旨在支持网络性能和可靠的建筑基础设施。它包含许多标准的较小元件(结构化)和各种组件,包括电缆、连接
    的头像 发表于 04-07 10:58 529次阅读

    集成芯片的重要性和必要

    集成芯片在现代科技和工业中占据着至关重要的地位,其重要性和必要主要体现在以下几个方面。
    的头像 发表于 03-18 15:17 1491次阅读