提高代码可读性的 10 个技巧( 二 )



DRY 原则
 
DRY 代表不要重复你劳动(Don't Repeat Yourself) 。也被称为 DIE:复制是不可接受的(Duplication is Evil) 。
该原则规定:
“每个知识必须在一个系统内具有一个唯一的、明确的、权威的表示 。”
大多数应用程序(或通用的计算机)的目标是使重复的任务变得自动化 。这个原则应该在所有的代码中保留,包括 Web 应用程序中 。同一段代码不应该一再地被重复 。
例如,大多数 Web 应用程序由许多页面组成 。这些页面很可能包含通用的元素 。标题和页脚通常是最佳证明 。将这些页眉和页脚在每个页面中复制一份并不是一个好主意 。Jeffrey Way 在此解释了如何在 CodeIgniter 中创建模板 。

提高代码可读性的 10 个技巧

文章插图
 
 

避免深嵌套
 
过多的嵌套层次会使代码变得难以阅读和跟踪
提高代码可读性的 10 个技巧

文章插图
 
 
为了提高可读性,通常会通过修改代码来减少嵌套的层级:
提高代码可读性的 10 个技巧

文章插图
 
 

限制行长度
 
人眼在阅读窄长的列式文本时感觉更舒适,这也是为什么报纸的文章都是这个样子:
提高代码可读性的 10 个技巧

文章插图
 
 
避免代码行水平过长是一种良好的变成习惯
提高代码可读性的 10 个技巧

文章插图
 
 
当然,如果有人,比如 Vim 用户,想要在终端窗口中阅读你的代码,最好将代码行的长度限制在 80 个字符左右 。

文件和文件夹的组织
 
从技术上讲,你可以在单个文件中编写整个应用程序的代码 。但是,这对阅读和维护来说将是一个噩梦 。
在我的第一个编程项目中,我懂得了创建“包含文件”的作法 。不过,我还没有接触过远程组织 。我创建了一个“inc”文件夹,其中包含两个文件:db.php 和 functions.php 。随着应用的扩展,functions 文件也变得庞大和不可维护 。
最好的方法之一就是使用框架或者模拟其文件夹结构 。下面是 CodeIgniter 的代码布局:
提高代码可读性的 10 个技巧

文章插图
 
 

一致的临时变量命名
 
通常,变量应该是描述性的,并且包含一个或多个单词 。但是,这并不一定适用于临时变量 。它们可以短到单个字符的长度 。
对于具有相同作用的临时变量,使用一致的命名是一个很好的做法 。以下是我在代码中常用的几个示例:
提高代码可读性的 10 个技巧

文章插图
 
 
探索 TDM 对于敏捷、DevOps 和持续交付中速度和质量的必要性 。与 CA 技术一起携手合作 。




推荐阅读