提高代码可读性的10个技巧 -买球官网平台

0顶
0踩

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

2017-10-20 09:45 by 副主编 jihong10102006 评论(0) 有6474人浏览
引用
原文:
作者:manas sadangi
译者:teixeira10

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

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

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

1 注释和文档

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

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

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

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

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 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('[email protected]')->add_to('[email protected]')->set_subject('methods chained')->set_body('some long message')->send();   
// good
$my_email   
->set_from('[email protected]')    
  ->add_to('[email protected]')    
  ->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'";

而且,如果有人打算从终端窗口读取代码,比如,那么将行长度限制为大约80个字符是一个比较好的做法。

9 文件和文件夹结构
从技术上讲,可以在一个文件中编写整个应用程序的代码,但这一定是阅读和维护代码的噩梦。

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

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

10 一致的临时命名

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

对于相同类型的临时变量,使用一致的命名是很好的做法。下面是我在代码中使用的一些例子:
// $i for loop countersfor
($i= 0; $i
  • 大小: 55.6 kb
  • 大小: 148.5 kb
  • 大小: 91.8 kb
  • 大小: 121.6 kb
0
0
评论 共 0 条 请登录后发表评论

发表评论

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

相关推荐

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

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

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

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

  • 原标题:phper必备|提升代码可读性的 10 个技巧具有较强可读性的代码,能帮助你调试程序,不让自己活得太累。代码可读性是计算机编程领域中普遍存在的问题。这也是我们成为开发者首先要学习的事情之一。本文会详细...

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

  • python的可读性和简单性是其广受欢迎的两大原因,本文介绍20个常用的python技巧来提高代码的可读性,并能帮助你节省大量时间,下面的技巧将在你的日常编码练习中非常实用。1. 字符串反转字符串反转有很多方法,咱们...

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

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

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

global site tag (gtag.js) - google analytics