PHP编程的五个良好习惯_建站学-个人建站指南,网页制作,网站设计,网站制作教程

根据具体的情况，一般的开发人员往往比优秀的开发人员的效率低 10%~20%。优秀的开发人员的效率更高，因为他们拥有丰富的经验和良好的编程习惯。不良的编程习惯将会影响到效率。本文通过展示一些良好的编程习惯，帮助您成为更优秀的程序员。

这些良好的编程习惯不仅能提高效率，还能让您编写出在应用程序的整个生命周期中易于维护的代码。编写出来的代码可能需要大量的维护；应用程序的维护是一笔很大的开支。养成良好的编程习惯能够提高设计质量（比如模块化），从而使代码更加容易理解，因此维护就更加容易，同时也降低维护成本。

不良的编程习惯会造成代码缺陷，使其难以维护和修改，并且很可能在修改时又引入其他缺陷。以下是 5 个良好的编程习惯，能够帮助 PHP 代码避免这些缺陷：

◆使用良好的命名。

◆分成更小的部分。

◆为代码添加注释。

◆处理错误条件。

◆切忌使用复制粘贴。

下面将详细介绍这些习惯：

使用良好的命名

使用良好的命名是最重要的编程习惯，因为描述性强的名称让代码更加容易阅读和理解。代码是否好理解取决于是否能在未来维护它。即便代码不带有注释，如果它很容易理解，将大大方便日后的更改。这个习惯的目标是让您编写的代码像书本一样容易阅读和理解。

不良习惯：含糊的或无意义的名称

清单 1 中的代码包含过短的变量名、难以辨认的缩写词，并且方法名不能反映该方法的功能。如果方法名给人的感觉是它应该做这件事情，而实际中它却做另外的事情，这将带来严重的问题，因为它会误导人。

清单 1. 不良习惯：含糊的或无意义的名称

＜?php
function getNBDay($d){
    switch($d) {
        case 5:
        case 6:
        case 7:
            return 1;
        default:
            return ($d + 1);
    }
}
$day = 5;
$nextDay = getNBDay($day);
echo ("Next day is: " . $nextDay . "n");
?＞

清单 2 中的代码体现了良好的编程习惯。新的方法名具有很强的说明性，反映了方法的用途。同样，更改后的变量名也更具说明性。惟一的保持最短的变量是 $i，在本清单中，它是一个循环变量。尽管很多人不赞同使用过短的名称，但在循环变量中使用还是可以接受的（甚至有好处），因为它明确表明了代码的功能。

清单 2. 良好习惯：说明性强并且简洁的名称

＜?php
define ('MONDAY', 1);
define ('TUESDAY', 2);
define ('WEDNESDAY', 3);
define ('THURSDAY', 4);
define ('FRIDAY', 5);
define ('SATURDAY', 6);
define ('SUNDAY', 7);
/*
*
* @param $dayOfWeek
* @return int Day of week, with 1 being Monday and so on.
*/
function findNextBusinessDay($dayOfWeek){
    $nextBusinessDay = $dayOfWeek;
    switch($dayOfWeek) {
        case FRIDAY:
        case SATURDAY:
        case SUNDAY:
            $nextBusinessDay = MONDAY;
            break;
        default:
            $nextBusinessDay += 1;
            break;
    }
     return $nextBusinessDay;
}
$day = FRIDAY;
$nextBusDay = findNextBusinessDay($day);
echo ("Next day is:" . $nextBusDay . "n");
?＞

我们鼓励您将大的条件拆分为一个方法，然后用能够描述该条件的名字命名方法。这个技巧能够提高代码的可读性，并且能够将条件具体化，使之能够被提取甚至重用。如果条件发生变化，更新方法也很容易。因为方法拥有一个有意义的名字，所以它能反映代码的用途，让代码更容易阅读。

分成更小的部分

专心解决一个问题之后再继续编程，这样会让您更轻松。在解决一个紧急的问题时，如果继续编程，会使函数越来越长。从长远来说，这并不是一个问题，但您要记得回过头来将它重构为更小的部分。

重构是个不错的主意，但您应该养成编写更短、功能更集中的代码。短的方法能够在一个窗口中一次看完，并且容易理解。如果方法过长，不能在一个窗口中一次看完，那么它就变得不容易理解，因为您不能快速地从头到尾了解它的整个思路。

构建方法时，您应该养成这样的习惯，让每个方法只完成一件事情。这个习惯很好，因为：首先，如果方法只完成一件事情，那么它就更容易被重用；其次，这样的方法容易测试；第三，这样的方法便于理解和更改。

不良习惯：过长的方法（完成很多件事情）

清单 3 展示了一个很长的函数，其中存在很多问题。它完成很多件事情，因此不够紧凑。它也不便于阅读、调试和测试。它要做的事情包括遍历一个文件、构建一个列表、为每个对象赋值、执行计算等等。

清单 3. 不良习惯：过长的函数

＜?php
function writeRssFeed($user)
{
    // Get the DB connection information


    // look up the user's preferences...
    $link = mysql_connect('mysql_host', 'mysql_user', 'mysql_password')
        OR die(mysql_error());
    // Query
    $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",
            mysql_real_escape_string($user));
    $result = mysql_query($query, $link);

    $max_stories = 25; // default it to 25;

    if ($row = mysql_fetch_assoc($result)) {
        $max_stories = $row['max_stories'];
    }

    // go get my data
    $perfsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",
            mysql_real_escape_string());

    $result = mysql_query($query, $link);
    $feed = "＜rss version="2.0"＞" .
        "＜channel＞" .
        "＜title＞My Great Feed＜/title＞" .
        "＜link＞http://www.example.com/feed.xml＜/link＞" .
        "＜description＞The best feed in the world＜/description＞" .
        "＜language＞en-us＜/language＞" .
        "＜pubDate＞Tue, 20 Oct 2008 10:00:00 GMT＜/pubDate＞" .
        "＜lastBuildDate＞Tue, 20 Oct 2008 10:00:00 GMT＜/lastBuildDate＞" .
        "＜docs＞http://www.example.com/rss＜/docs＞" .
        "＜generator＞MyFeed Generator＜/generator＞" .
        "＜managingEditor＞editor@example.com＜/managingEditor＞" .
        "＜webMaster＞webmaster@example.com＜/webMaster＞" .
        "＜ttl＞5＜/ttl＞";

        // build the feed...
        while ($row = mysql_fetch_assoc($result)) {
            $title = $row['title'];
            $link = $row['link'];
            $description = $row['description'];
            $date = $row['date'];
            $guid = $row['guid'];
            $feed .= "＜item＞";
            $feed .= "＜title＞" . $title . "＜/title＞";
            $feed .= "＜link＞" . $link . "＜/link＞";
            $feed .= "＜description＞ " . $description . "＜/description＞";
            $feed .= "＜pubDate＞" . $date . "＜/pubDate＞";
            $feed .= "＜guid＞" . $guid . "＜/guid＞";
            $feed .= "＜/item＞";
        }
        $feed .= "＜/rss";
        // write the feed out to the server...
        echo($feed);
}
?＞

良好习惯：易管理、功能专一的方法
清单 4 将原来的方法改写为更加紧凑、易读的方法。在这个示例中，将一个很长的方法分解为几个短方法，并且让每个短方法负责一件事情。这样的代码对将来的重用和测试都是大有裨益的。

清单 4. 良好习惯：易管理、功能专一的方法

＜?php
function createRssHeader()
{
    return "＜rss version="2.0"＞" .
        "＜channel＞" .
        "＜title＞My Great Feed＜/title＞" .
        "＜link＞http://www.example.com/feed.xml＜/link＞" .
        "＜description＞The best feed in the world＜/description＞" .
        "＜language＞en-us＜/language＞" .
        "＜pubDate＞Tue, 20 Oct 2008 10:00:00 GMT＜/pubDate＞" .
        "＜lastBuildDate＞Tue, 20 Oct 2008 10:00:00 GMT＜/lastBuildDate＞" .
        "＜docs＞http://www.example.com/rss＜/docs＞" .
        "＜generator＞MyFeed Generator＜/generator＞" .
        "＜managingEditor＞editor@example.com＜/managingEditor＞" .
        "＜webMaster＞webmaster@example.com＜/webMaster＞" .
        "＜ttl＞5＜/ttl＞";
}
function createRssFooter()
{
    return "＜/channel＞＜/rss＞";
}
function createRssItem($title, $link, $desc, $date, $guid)
{
    $item .= "＜item＞";
    $item .= "＜title＞" . $title . "＜/title＞";
    $item .= "＜link＞" . $link . "＜/link＞";
    $item .= "＜description＞ " . $description . "＜/description＞";
    $item .= "＜pubDate＞" . $date . "＜/pubDate＞";
    $item .= "＜guid＞" . $guid . "＜/guid＞";
    $item .= "＜/item＞";
    return $item;
}
function getUserMaxStories($db_link, $default)
{
    $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",
            mysql_real_escape_string($user));
    $result = mysql_query($perfsQuery, $db_link);

    $max_stories = $default;

    if ($row = mysql_fetch_assoc($result)) {
        $max_stories = $row['max_stories'];
    }

    return $max_stories;
}
function writeRssFeed($user)
{
    // Get the DB connection information
    $settings = parse_ini_file("rss_server.ini");

    // look up the user's preferences...
    $link = mysql_connect($settings['db_host'], $settings['user'],
        $settings['password']) OR die(mysql_error());
    $max_stories = getUserMaxStories($link, 25);

    // go get my data
    $newsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",
            mysql_real_escape_string(time()));

    $result = mysql_query($newsQuery, $link);
    $feed = createRssHeader();

    $i = 0;
    // build the feed...
    while ($row = mysql_fetch_assoc($result)) {
        if ($i ＜ $max_stories) {
            $title = $row['title'];
            $link = $row['link'];
            $description = $row['description'];
            $date = $row['date'];
            $guid = $row['guid'];
            $feed .= createRssItem($title, $link, $description, $date, $guid);

            $i++;
        } else {
            break;
        }
    }

    mysql_close($link);
    $feed .= createRssFooter();
    // write the feed out to the server...
    echo($feed);
}
?＞

为代码添加注释

要为代码添加良好的注释有时似乎和编写代码一样难。要了解应该为哪些内容添加注释并不容易，因为我们常常倾向于注释代码当前做的事情。注释代码的目的是不错的主意。在函数的不是很明显的头部代码块中，告诉读者方法的输入和输出，以及方法的最初目标。

注释代码当前做什么是很常见的，但这是不必要的。如果代码很复杂，不得不注释它当前在做什么，这将暗示您应该重写代码，让它更容易理解。学会使用良好的名称和更短的方法，在不提供注释说明其用途的情况下提高代码的可读性。

不良习惯：函数注释过多或不足

清单 5 中的注释仅告诉读者代码在做什么 — 它正在通过一个循环进行迭代或添加一个数字。但它忽略了它为什么做当前的工作。这使维护该代码的人员不知道是否可以安全地更改代码（不引入新缺陷）。

清单 5. 不良习惯：函数注释过多或不足

良好习惯：带注释的函数和类

清单 6 中的注释告诉读者类和方法的目的。该注释解释了为什么代码在做当前的工作，这对未来维护代码十分有用。可能需要根据条件变更而修改代码，如果能够轻松了解代码的目的，则修改起来很容易。 (责任编辑：admin)

搜索

热门标签:

PHP编程的五个良好习惯