欢迎来到IT88168,IT88168开拓您的IT创收之路 访问移动版

如何提高源代码的可读性和可维护性

日期: 2020-06-16 14:05:32 人气: -

高质量代码的三个要素:

可读性,可维护性和可变性

做好代码规范,提高代码质量,可以大大提高代码的可读性,可维护性和可变性。努力提高代码读写的可读性是良好代码规范的必要和不足条件。代码规范和体系结构设计是软件的灵魂。低代码质量就像一个人,失去了三个灵魂和七个灵魂之一,将失去活力,影响正常运行,在软件交付后增加维护成本,并推迟完成,超额预算,缺少功能等。


任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都必须以相同的方式编写代码至关重要。这样每个人都可以轻松理解和维护彼此的代码。


实际上,每个公司都会有一个(或多个)代码规范,因此提高代码可读性的关键在于它是否可以实施公司的相关文件,公司的技术总监,项目经理或相关代码审查机构是否具备适当执行。如果无法实现,那么即使代码规范被漂亮地绘制,特定的代码也将很难被折叠。


代码规范

如果您不希望将来陷入困境,那么程序员,团队负责人和项目经理都必须掌握良好的代码规范。 如何确保当前的项目开发过程处于正常压力下,而不是在后期面临太多压力,从而使噩梦纠缠不休? 最简单的方法是照顾您的代码,即实施公司的代码规范工作。 每天花费一点精力,您就可以避免代码衰减,并确保将来不会变得难以理解(可读性)和维护(可维护性)。


代码可读性

代码的可读性是指代码易于阅读,跟踪和理解的程度。 提高代码的可读性可以节省代码阅读器的时间(避免在阅读时浪费太多不必要的时间)和精力(调试,扩展功能或性能优化的先决条件是您必须了解此代码)。 以下是一些可供参考的策略:


编码风格一致


代码清楚地表达了意图

写下别人可以理解的单词,如果选择英语,则避免使用日语,法语和汉语拼音,请尝试使用语义命名的组合;

PIE原则:意图明确,程序明确;

可以快速理解(最低要求是一个月后您可以快速理解);

恰到好处的音符

注释不应太多或太少,注释的形式根据代码的具体情况而有所不同;

避免用注释包装代码;

尽量留下简明扼要的笔记;

评估权衡(不要编写大段代码)

避免编写现在不再需要并且将来不太可能需要的功能:

缺陷:不要写太多代码(例如会话存储拆分);

避免进行没有太多价值的优化工作;

优先任务:

头痛和处理:首先容忍失败,然后解决问题(例如节点关闭逻辑);

无头痛,无药物治疗:定量分析(如参数调整和回滚等);

全面考虑性能,便利性,生产率,成本和上市时间...

简单就是美,避免使用简单的功能编写复杂的代码;

保持简单的代码要比编写复杂的代码困难得多,但这是值得的。

不要写有趣的代码;

避免不必要的条件嵌套和过度封装;

乍一看,可以看到该代码是有用的,它是简单漂亮的代码

坚持操作方法的原子性,然后使用组合方式实现业务逻辑;

避免使用大量的代码,而编写高内聚和低耦合的代码;


代码可维护性

软件可维护性是指理解,纠正,更改和改进软件的困难。通常影响软件可维护性的因素是清晰度,可测试性和可修改性。作者在这里将其分为两类:编写时的可维护性和运行时的可维护性。


撰写本文时的可维护性


撰写本文时的可维护性意味着该漏洞会在程序或系统上线后被打破,并且开发团队可以及时消除该漏洞而不会破坏其他漏洞。保持该方法的原子性并改善代码的内聚性可以最大程度地减少某处修改的影响。这样,某处方法的错误将不会影响其他模块的正常运行。撰写本文时的可维护性还包括代码的可测试性。


可运行性


运行时可维护性意味着系统的某些配置在系统运行期间被修改且有效(或无需进行编码和释放,仅需重新启动系统一次),并且不会影响正在进行的操作和用户操作。这就要求软件工程师不能编写代码。例如,配置文件,数据库连接字符串,资源文件,日志等。

以下是一些可供参考的策略:


不要把代码写死掉。


预期可能的变化


通过提高代码可重用性来提高代码可维护性


代码可写性


代码的可写性包括代码的可更改性。 代码的可变性是软件理论的核心。


代码的可写性基于代码的可维护性,而代码的可写性和可维护性均基于代码的可读性。 如果代码难以阅读,则错误修复程序将很难启动,并且添加新功能甚至更不可能启动。

【版权与免责声明】如发现内容存在版权问题,烦请提供相关信息发邮件至nnt@nnt.Ltd,我们将及时沟通与处理。 本站内容除了IT88168(www.IT88168.com )原创外,其它均为网络转载内容。