微信号:phpdevelopers

介绍:PHP开发者(phpdevelopers)-做最专业的PHP资源分享平台!

如何编写可读性与维护性好的代码

2018-09-16 18:00 文青


什么样的代码是可读性好的代码呢

“让人阅读你的代码,就像阅读优美的文章一样流畅!”——这就是好代码!

把代码当作一篇优美的散文来写!用这样的标准来要求自己,一定会写出好代码,一定会成为一个优秀的程序员。代码不仅是写给机器编译的,更是写给人看的!代码不仅是代码,更是文档!


高质量代码的三大要素:可读性、可维护性和可变更性

做好代码规范、提高代码质量,能显著增强代码的可读性、可维护性和可变更性。努力提高代码的读写可维护性,是做好代码规范的必要非充分条件。代码规范和架构设计是软件的灵魂所在,代码质量偏低,就像是人失去了三魂七魄中的一魄,就会丧失活力,影响正常运行,增加软件交付后维护成本,出现推迟完成、超出预算、特性缺失等现象。

任何语言都需要强调编码风格的一致性。只要是团队开发,每个人都以相同的方式编写代码就是至关重要的。这样大家才能方便地互相看懂和维护对方的代码。


代码规范

如果不想为以后挖坑,做好代码规范是程序员和团队负责人、项目经理的必修课。如何保证当前项目开发过程中压力正常,而不是在后期面对过多的压力、以至于噩梦缠身?最简单的办法就是照看好你的代码,也就是落实好公司的代码规范工作。每天为此付出一丁点的努力,便可以避免代码腐烂,并保证代码产品日后不至于变得难以理解(可读性)和维护(可维护性)。

代码的可读性

代码的可读性是指代码让人容易阅读、跟踪和理解的程度。提高代码的可读性可以为代码阅读者节约时间(避免阅读时浪费过多无谓的时间)和精力(Debug、扩展功能或是性能优化的前提条件是你要读懂这段代码)。以下是摘选的可供参考的策略:

  • 编码风格一致

  • 代码清晰表达意图

    • 写别人看得懂的单词,如果选用英语,那么避免日语、法语和汉语拼音等,尽量使用语义化的命名组合;

    • PIE 原则:意图清楚而且表达明确地编程;

    • 能够让人快速看懂(最低限度的要求是自己一个月后能快速读懂);

  • 恰到好处的注释

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

    • 避免用注释包裹代码;

    • 尽量留下简明扼要的注释;

  • 评估取舍(不要编写大段的代码)

    • 头疼医头也医脚:先容忍失败,再解决问题(如节点关闭逻辑);

    • 不头疼不医头:量化分析(如参数调整回滚等);

    • 不完美主义:不多写代码(如会话存储拆分);

    • 避免写一些现在不需要、将来也不太可能需要的功能:

    • 避免做没有太大价值的优化工作;

    • 区分任务的轻重缓急:

    • 综合考虑一下性能、便利性、生产力、成本和上市时间……

  • 简单就是美,避免简单的功能写出复杂的代码;

    • 保持简单的代码远比写出复杂代码要难得多,但这是值得的;

    • 不编写讨巧的代码;

    • 避免无谓的条件嵌套和过度封装;

    • 第一眼看上去就能知道其用处的代码,才是简单而美的代码

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

    • 避免大段代码,要写高内聚、低耦合的代码;



您看此文用  · 秒,转发只需1秒

 
php开发者 更多文章 ThinkPHP5.0目录结构详解 vim命令总结 理解PHP同步阻塞、和异步IO php中ob_start()系列函数的使用 10个实用的PHP正则表达式
猜您喜欢 援助交际:联合国特使称日本13%女中学生“卖春” 数学红楼梦:有钱也是一种才能 RPC 使用中的一些注意点 Windows Azure 研发经理胡鲁辉:技术总是相通的,不同的是产品 SQL 基础知识梳理(三) - 聚合和排序