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

资讯频道 → 研发管理

0顶
0踩

2017-10-20 09:45 by 副主编 jihong10102006 评论(0) 有6807人浏览

代码可读性

声明：ITeye资讯文章的版权属于ITeye网站所有，严禁任何网站转载本文，否则必将追究法律责任！

引用

原文：10 Tips for Improving the Readability of Your Code
作者：Manas Sadangi
译者：Teixeira10

【译者注】在本文中，作者从注释，缩进，代码分组，命名方式等方面，介绍了10个提高代码可读性的技巧，供读者学习和借鉴。
以下为译文：

如果你的代码很容易阅读，这也会帮助你调试自己的程序，让工作变得更容易。

代码可读性是计算机编程领域的一个普遍课题，这也是作为开发人员首先要学习的东西。本文将详细介绍几个编写可读代码的最佳实践。

1 注释和文档

IDE(集成开发环境)在过去的几年里取得了很大的提升，也让你的代码比以前更容易进行注释了。注释会遵循一定的标准，这就允许IDE和其他工具以不同的方式来使用它们。
考虑一下这个例子:

在函数定义中添加的注释可以在使用该函数时进行查看，即使是在其他文件中使用该函数也同样可以查看注释。

下面是另一个例子，从第三方库调用函数:

在这些示例中，使用的注释(或文档)的类型基于PHPDoc，而IDE则是基于Aptana。

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 Style

function foo()
{ //placed on the next line
    if($maybe) { // placed on the same line
        do_it_now();
        again();
    } else {
       abort_mission();
    }
    finalize();
}

另外，请注意，这里使用的是四个空格，而不是使用tab键进行缩进。

这是一篇维基百科的文章，有不同缩进风格的样式。

3 避免冗余的注释

对你的代码进行注释是很棒的行为，然而，它可能是过量的，或者是冗余的。来看这个例子:

// get the country code
$country_code = get_country_code($_SERVER['REMOTE_ADDR']);
// if country code is US
if ($country_code == 'US'){
// display the form input for state
echo form_input_state();
}

当内容很显而易见的时候，进行重复的注释是很没有效率的。

如果你必须对该代码进行注释，那你可以简单地将其合并到一行中:

// display state selection for US users
$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');

在每个代码块的开头添加注释，视觉上看起来就是分离的代码块了。

5 一致的命名方案

PHP有时会犯不遵循一致命名方案的错误：

strpos() vs. str_split()
imagetypes() vs. image_type_to_extension()

首先，命名应该有单词边界。有两种比较流行的选择:

引用

camelCase(骆驼拼写法)：除了第一个单词,每个单词的第一个字母都大写。
underscores(下划线)：在单词之间加下划线，例如:mysql_real_escape_string()。

类似于前面提到的缩进方式，命名方式也会有不同的选择。如果现有的项目遵循一定的方案，那么你应该使用它。此外，一些语言倾向于使用一种命名方案。例如，在Java中，大多数代码都使用camelCase方式来命名，而在PHP中，大部分代码都使用underscores命名方式。

当然这些方式也可以混合，一些开发人员倾向于使用underscores方式来处理过程函数和类名，但却使用camelCase方式来对类方法命名:

classFoo_Bar{
publicfunctionsomeDummyMethod(){
}

因此，没有所谓的“最佳”风格，仅仅是需要一致的风格。

6 DRY Principle（干燥原理）

DRY意思是不要重复，即DIE: Duplication is Evil.（复制是邪恶的）
原则如下:
“每一条知识都必须在一个系统中有一个单一的、明确的、权威的表示。”

大多数应用程序(或一般计算机)的目的是使重复的任务自动化，所以这项原则应该在所有代码中体现出来，甚至是web应用程序。同样的代码不应该一次又一次地重复。

例如，大多数web应用程序由许多页面组成，很有可能这些页面包含公共元素，就比如页眉和页脚。然而，将这些页眉和页脚粘贴到每个页面并不是一个好方法。下面是Jeffrey Way解释如何在CodeIgniter中创建模板。

$this->load->view('includes/header');   
$this->load->view($main_content);   
$this->load->view('includes/footer');

7 避免嵌套太深

嵌套过多会使代码更难读取和跟踪。

functiondo_stuff(){
// ...
if (is_writable($folder)){
    if ($fp = fopen($file_path, 'w')){
        if ($stuff = get_some_stuff()){
            if (fwrite($fp, $stuff)){
// ...
   }
      else
   {
    returnfalse;
   }
  }
  else
{

为了便于阅读，通常可以修改代码以减少嵌套级别:

functiondo_stuff(){
// ...
if (!is_writable($folder)){
returnfalse;
}
if (!$fp = fopen($file_path, 'w')){
returnfalse;
}
if (!$stuff = get_some_stuff()){
returnfalse;
}
if (fwrite($fp, $stuff)){
// ...
}
  else
{
returnfalse;
}
}

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 文件和文件夹结构
从技术上讲，可以在一个文件中编写整个应用程序的代码，但这一定是阅读和维护代码的噩梦。

在我的第一个编程项目中，我有创建“include files”的想法，然而还没有完全构建起来。我创建了一个“inc”文件夹，其中有两个文件db.php和functions.php。但随着应用程序的增加，函数文件也变得非常庞大，越来越不可维护。

最好的方法之一是使用框架或模仿文件夹结构。这就是CodeIgniter的样子:

10 一致的临时命名

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

对于相同类型的临时变量，使用一致的命名是很好的做法。下面是我在代码中使用的一些例子:

// $i for loop countersfor
($i= 0; $i

查看图片附件

分享到：

0
顶

0
踩

评论共 0 条请登录后发表评论

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

提高代码可读性的十大注释技巧分享

主要介绍了提高代码可读性的十大注释技巧,详细分析了编程开发中常用的代码注释方法,需要的朋友可以参考下

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

提高代码可读性的10个注释技巧,sunshine1028,即日启程，李鸿明

提高 Python 代码可读性的 5 个基本技巧

不知道小伙伴们是否有这样的困惑，当我们回顾自己 6 个月前编写的一些代码时，往往会看的一头雾水，或者是否当我们接手其他人的代码时， Python 中有许多方法可以帮助我们理解代码的内部工作原理，良好的编程习惯，...

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

那些能直接看出含义的代码不需要写注释，特别是不需要为每个方法都加上注释，比如那些简单的 getter 和 setter 方法，为这些方法写注释反而让代码可读性更差。不能因为有注释就随便起个名字，而是争取起个好名字而...

提高代码可读性的注释技巧实用型

下面分享十个加注释的技巧：为每个代码块添加注释，并在每一层使用统一的注释方法和风格。例如： · 针对每个类：包括摘要信息、作者信息、以及最近修改日期等; · 针对每个方法：包括用途、功能、参...

提升代码可读性技巧

逻辑或|| 的短路运算：若左边能转成true，返回左边式子的值，反之返回右边式子的值。这里值一层的三元运算符，如果多层嵌套的三元运算符，代码可读性也很差。的短路运算有时候可以用来代替一些比较简单的if/else。

代码审查：提高代码质量的10个技巧

代码审查可以有效地改善代码质量，保障代码质量，并且减少代码缺陷和代码安全性隐患，促进团队合作，增强软件产品的稳定性和可靠性。作为开发人员，在提交代码前应该经过代码审查。然而，在实际工作中，代码

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

在本文中，作者从注释，缩进，代码分组，命名方式等方面，介绍了10个提高代码可读性的技巧，供读者学习和借鉴。以下为译文：如果你的代码很容易阅读，这也会帮助你调试自己的程序，让工作变得更容易。 ...

Matlab注释：提高代码可读性的小技巧

以上是几个简单的技巧，可帮助你更好地注释 Matlab 代码，提高其可读性和可理解性。为了解决这个问题，本文将介绍一些简单的技巧，帮助你更好地注释 Matlab 代码，提高其可读性和可理解性。% 这个函数计算两个数的和...

提高php代码可读性的三个技巧【转】

() ; } ...// 上百行代码... ...2.用foreach:endforeach,for:endfor,if:endif,这样的语法来写模板里的代码 ...可读性不好的写法: echo " &lt;table size= \" 100 \" &a

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

代码可读性是计算机编程领域中普遍存在的问题。这也是我们成为开发者首先要学习的事情之一。本文会详细介绍在编写强可读性代码时最佳实践中最重要的一部分内容。 1 - 注释和文档 IDE（Integrated ...

提高代码可读性的十大注释技巧

下面分享十个加注释的技巧： 1. 逐层注释为每个代码块添加注释，并在每一层使用统一的注释方法和风格。例如：针对每个类：包括摘要信息、作者信息、以及最近修改日期等；针对每个方法：包

06_QLibrary.zip

毕业设计: 基于Densenet + CTC技术的文字检测识别的技术研究

本毕设课题是属于计算机视觉下的目标检测与识别，对象为自然场景下的各种文本信息，通俗的说就是检测识别图片中的文本信息。由于文本的特殊性，本毕设将整个提取信息的过程可以分为检测、识别两个部分。论文对用到的相关技术概念有一定的介绍分析，如机器学习，深度学习，以及各种的网络模型及其工作原理过程。检测部分采用水平检测文本线方式进行文本检测，主要参考了乔宇老师团队的 CTPN 方法，并在正文部分从模型的制作到神经网络的设计实现对系统进行了较为详细的分析介绍。识别部分则采用的是 Densenet + CTC，对于印刷体的文字有较好的识别。

毕业设计基于javaweb的在线答题平台

numpy安装 python get-pip.py

numpy安装 numpy安装 python get-pip.py

基于用户、物品的协同过滤算法.zip

协同过滤算法（Collaborative Filtering）是一种经典的推荐算法，其基本原理是“协同大家的反馈、评价和意见，一起对海量的信息进行过滤，从中筛选出用户可能感兴趣的信息”。它主要依赖于用户和物品之间的行为关系进行推荐。协同过滤算法主要分为两类：基于物品的协同过滤算法：给用户推荐与他之前喜欢的物品相似的物品。基于用户的协同过滤算法：给用户推荐与他兴趣相似的用户喜欢的物品。协同过滤算法的优点包括：无需事先对商品或用户进行分类或标注，适用于各种类型的数据。算法简单易懂，容易实现和部署。推荐结果准确性较高，能够为用户提供个性化的推荐服务。然而，协同过滤算法也存在一些缺点：对数据量和数据质量要求较高，需要大量的历史数据和较高的数据质量。容易受到“冷启动”问题的影响，即对新用户或新商品的推荐效果较差。存在“同质化”问题，即推荐结果容易出现重复或相似的情况。协同过滤算法在多个场景中有广泛的应用，如电商推荐系统、社交网络推荐和视频推荐系统等。在这些场景中，协同过滤算法可以根据用户的历史行为数据，推荐与用户兴趣相似的商品、用户或内容，从而提高用户的购买转化率、活跃度和社交体验。未来，协同过滤算法的发展方向可能是结合其他推荐算法形成混合推荐系统，以充分发挥各算法的优势。

strcmp函数应用.zip

2.py

0顶0踩