当前位置: 首页 > 后端技术 > PHP

关于代码可读性的随想

时间:2023-03-29 16:11:59 PHP

原文:https://www.codecasts.com/blo...本文探讨了编程中的一个术语:“可读性”。首先让我们谈谈它的含义:“可读性”描述了在没有其他开发人员过多关联或猜测的情况下理解代码的含义。为了使您的代码对其他开发人员“可读”,您需要仔细选择每个变量名甚至参数名。但有些东西是普遍的,受人为因素的限制。例如,很少有开发人员跟踪未命名的变量名。启发式:变量、类、方法和其他引用是否具有明确的名称?或者从开发者自身的角度,这些开发者是否熟悉被接手项目的代码?他们作为开发人员的经验如何?他们是否有使代码对他们来说或多或少可读的特定背景?但是我们通常会遇到这样的应用场景:你不知道其他开发者是谁?这在开源项目中最为普遍。这就是为什么我们在编程中有标准、模式和最佳实践。比如JavaScript代码倾向于使用camelCase(驼峰命名),所以用camelCase写代码可以提供一种流畅感(可以起到可读性的作用)。了解一种语言中常用的常见模式和样式很重要。补充:你的团队可能已经制定了一些自己的编程规则;请此时跟进。以下是一些简单实用的方法:尝试使用描述性变量名称。较长的变量通常更具可读性。使用空格!代码编译器的存在意味着空格与代码执行无关,但对人类来说,空格很重要!所以利用这个优势。在抽象和实用之间找到平衡。例如,最简单的任务不需要10层重定向;相反,从最简单的方法开始,并在重构过程中将其抽象化。“让代码跑起来,然后跑对,最后跑得快。”注意这个顺序。这将极大地提高代码的可读性,因为您首先要理解,然后再转向性能。这会预先建立您的架构和语义,并且您更有可能以这种方式保持良好的语义。了解你的听众。如果您的听众不习惯内联lambda计算,请不要使用它。即使您认为这是解决问题的“最佳方法”,也有其他同样可行的方法。遵循完善的重构和面向对象的模式。老实说,这些概念都被前人尝试过了。你可以坚持下去,不用怀疑太多。但!也不要盲目遵守规则。不时花一些时间重新审视代码:有什么奇怪的地方吗?这令人困惑吗?是不是这样写比较好?可读代码并不总是可维护的,反之亦然。可维护的代码通常是按照良好的实践和原则构建的。测试对于代码库维护非常重要!拥有良好的测试覆盖率可以让您不必将所有代码都记在脑子里。(注意:测试并不能一起消除错误,但测试可以帮助你很多。)总而言之,编程是一个人的过程。编写代码时请遵循以下建议:通常越简单越好——欧内斯特·海明威(ErnestHemingway)。