技术开发 频道

PHP 编程的 5 个良好习惯

  使用良好的命名

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

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

  清单 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");

?
>

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

0
相关文章