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

2 - 保持一致的缩进

假设你已经知道代码需要缩进。不过值得注意的是，最好保持缩进样式一致。

缩进代码的方式很多，这里最最常见的两种：

风格 1:

function foo() {

    if($maybe){

        do_it_now();

        again();

    } else{

        abort_mission();

    }

    finalize();

}

风格 2:

function foo(){  

if($maybe) {  

 do_it_now();

        again();

    }else{  

 abort_mission();

    }

    finalize();

}

我以前使用的风格 #2，但最近改为 #1 了。但这个问题只是一个偏好的问题。没有“最好”的风格来让每一个人都去遵循。实际上，最好的风格就是一致的风格。如果你是团队的一员，或者你在向某个项目贡献代码，你就应该遵循项目中正在使用的风格。

缩进风格间并不总是会有明显的区别。有时候，不同的规则会产生混淆。比如，在 PEAR 编码标准中，前大括号“{”与控制结构在同一行，但在函数定义中却需要换行。

PEAR 风格:

function foo(){                    

// 放在下一行[译者注：示例中明明是放在与声明同行的，可能是作者笔误]

    if($maybe){     

      // 放在同一行

        do_it_now();

        again();

    }else{

       abort_mission();

    }

    finalize();

}

另外，请注意，缩进是用的 4 个空格而不是制表符。

这里是 Wikipedia 中不同缩进风格的示例。

3 - 避免显而易见的注释

注释代码非常棒；但是，如果注释只是简单的重复就显得多余了。看看这个示例：

// 获取国家/地区代码

$country_code = get_country_code($_SERVER[REMOTE_ADDR]);

// 如果国家/地区代码是 US

if ($country_code == US){

// 在表单中显示“州”输入框

echo form_input_state();

}

如果文本是显而易见的，真的没必要在注释里再写一次。

如果你一定要在代码里写点注释，可以把它们合并在一行：

// 对美国用户显示“州”输入框

$country_code = get_country_code($_SERVER[REMOTE_ADDR]);

if ($country_code == US){

echo form_input_state();

}

4 - 代码分组

某些任务往往不是几句代码就能解决的，那最好把这些任务代码分为不同的代码段，在它们之间添加一些空行。

下面是一个简单的示例：

// get list of forums

$forums = array();

$r = mysql_query("SELECT id, name, description FROM forums");

while ($d = mysql_fetch_assoc($r)){

$forums[] = $d;

// load the templates

load_template(header);

load_template(forum_list, $forums);

load_template(footer);

在每段代码前添加注释可以加强视觉分离效果。

下划线（underscores）: 在单词间使用下划线分隔，比如：mysql_real_escape_string()。

这一点与我前面提到使用不同缩进风格的情况相似。如果项目中已经在使用某个约定，你应该遵循它。另外，某些语言平台往往会有一个特定的命名规范。比如在 Java 中，多数代码使用驼峰命名风格，而多数 PHP 程序员使用下划线命名风格。

这些网络也可以混合使得。有些开发者喜欢对过程函数和类使用下划线风格，但对类方法使用驼峰风格：

class Foo_Bar {

    publicfunctionsomeDummyMethod(){

}

再强调一下，没有“最好”的风格，保持一致就好。

6 - DRY 原则

DRY 代表不要重复你劳动（Dont Repeat Yourself）。也被称为 DIE：复制是不可接受的（Duplication is Evil）。

该原则规定：

“每个知识必须在一个系统内具有一个唯一的、明确的、权威的表示。”

大多数应用程序（或通用的计算机）的目标是使重复的任务变得自动化。这个原则应该在所有的代码中保留，包括 Web 应用程序中。同一段代码不应该一再地被重复。

例如，大多数 Web 应用程序由许多页面组成。这些页面很可能包含通用的元素。标题和页脚通常是最佳证明。将这些页眉和页脚在每个页面中复制一份并不是一个好主意。 Jeffrey Way 在此解释了如何在 CodeIgniter 中创建模板。

$this- load- view(includes/header);   

$this- load- view($main_content);   

$this- load- view(includes/footer);

8 - 限制行长度

人眼在阅读窄长的列式文本时感觉更舒适，这也是为什么报纸的文章都是这个样子：

避免代码行水平过长是一种良好的变成习惯

//bad

$my_email- set_from(test@email.com)- add_to(programming@gmail.com)- set_subject(Methods Chained)- set_body(Some long message)- send();   

// good

$my_email   

- set_from(test@email.com)    

  - add_to(programming@gmail.com)    

  - set_subject(Methods Chained)   

  - set_body(Some long message)   

  - send();   

// bad

$query= "SELECT id, username, first_name, last_name, status FROM users LEFT JOIN user_posts USING(users.id, user_posts.user_id) WHERE post_id = 123";   

// good

$query= "SELECT id, username, first_name, last_name, status    

  FROM users   

  LEFT JOIN user_posts 

  USING(users.id, user_posts.user_id)    

  WHERE post_id = 123";

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

9 - 文件和文件夹的组织

从技术上讲，你可以在单个文件中编写整个应用程序的代码。但是，这对阅读和维护来说将是一个噩梦。

在我的第一个编程项目中，我懂得了创建“包含文件”的作法。不过，我还没有接触过远程组织。我创建了一个“inc”文件夹，其中包含两个文件：db.php 和 functions.php。随着应用的扩展，functions 文件也变得庞大和不可维护。

最好的方法之一就是使用框架或者模拟其文件夹结构。下面是 CodeIgniter 的代码布局：

10 - 一致的临时变量命名

通常，变量应该是描述性的，并且包含一个或多个单词。但是，这并不一定适用于临时变量。它们可以短到单个字符的长度。

对于具有相同作用的临时变量，使用一致的命名是一个很好的做法。以下是我在代码中常用的几个示例：

// $i for loop countersfor

($i= 0; $i  100; $i++) {       

  // $j for the nested loop counters    

  for($j= 0; $j  100; $j++) {       

// $ret for return variables

functionfoo() {    

 $ret[bar] = get_bar();    

 $ret[stuff] = get_stuff();       

 return$ret;

// $k and $v in foreachforeach

($some_arrayas$k=  $v) {   

// $q, $r and $d for mysql

$q= "SELECT * FROM table";

$r= mysql_query($q);

while($d= mysql_fetch_assocr($r)) {  

// $fp for file pointers\

$fp= fopen(file.txt,w);

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

原文发布时间为：2017-10-15 

本文作者：佚名

本文来自云栖社区合作伙伴“51CTO”，了解相关信息可以关注。

如何提高前端代码的可读性？ 可读性是代码质量的重要标准之一，也是前端开发者必须重视的问题。在团队开发中，一份可读性强的代码可以提高团队协作效率，减少代码维护成本。下面我们来探讨如何提高前端代码的可读性。
什么样的代码是可读性强的代码？ 什么样的代码是可读性强的代码？者不仅仅是一个新手开发者焦虑的问题，也是多年开发经验的老鸟也会焦虑的问题。下面我就从代码命名 、代码注释、设计文档等几个方面说说我的理解。
如何写出健壮的代码? 关于代码的健壮性，其重要性不言而喻。那么如何才能写出健壮的代码？阿里文娱技术专家长统将从防御式编程、如何正确使用异常和 DRY 原则等三个方面，并结合代码实例，分享自己的看法心得，希望对同学们有所启发。
使用JSDoc提高代码的可读性 工作了四年多，基本上都在围绕着 JavaScript 做事情。 写的代码多了，看的代码也多了，由衷的觉得，写出别人看不懂的代码并不是什么能力，写出所有人都能读懂的代码，才是真的牛X。 众所周知， JavaScript 是一个弱类型的脚本语言，这就意味着，从编辑器中并不能直观的看出这段代码的作用是什么，有些事情只有等到代码真正的运行起来才能够确定。
如何提高代码可读性、可维护性 高质量代码的三大要素： 可读性、可维护性和可变更性 做好代码规范、提高代码质量，能显著增强代码的可读性、可维护性和可变更性。努力提高代码的读写可维护性，是做好代码规范的必要非充分条件。代码规范和架构设计是软件的灵魂所在，代码质量偏低，就像是人失去了三魂七魄中的一魄，就会丧失活力，影响正常运行，增加软件交付后维护成本，出现推迟完成、超出预算、特性缺失等现象。