2.3 编码规范

俗话说，没有规矩，不成方圆。养成良好的编程习惯，能够提高代码质量和效率；而不良的编程习惯会造成代码缺陷，使其难以维护，并且很可能在维护时又引入新的缺陷。书写PHP代码时需要遵循一些基本的编程原则，这些原则称为编码规范。下面介绍一些常用的编码规范，这些规范对任何一个追求高质量的代码的人来说是必需的。

2.3.1 书写规范

1．缩进

每个缩进的单位约定是一个Tab（制表符）。语句块中的第一条语句需要缩进，同一个语句块中的所有语句上下对齐。

2．大括号{}

左大括号与关键词（如 if、else、for、while、switch 等）同行，右大括号与关键字同列。下面是符合上述两个书写规范的示例程序。

<?php

if ($condition){

switch ($var){

case 1:

echo 'var is 1';

break;

case 2:

echo 'var is 2';

break;

default:

echo 'var is neither 1 or 2';

break;

}

} else {

switch ($str){

case 'abc':

$result = 'abc';

break;

default:

$result = 'unknown';

break;

}

}

?>

3．运算符

每个运算符与两边参与运算的值或表达式中间要有一个空格，唯一的特例是字符串连接运算符号两边不加空格。下面是符合该规范的示例程序。

<?php

$b = 2;

$c = 3;

$a = $b + $c;

?>

2.3.2 命名规范

使用良好的命名也是重要的编程习惯，描述性强的名称让代码更加容易阅读、理解和维护。命名遵循的基本原则是：以标准计算机英文为蓝本，杜绝一切拼音或拼音英文混杂的命名方式，建议使用语义化的方式命名。

1．类

类名每一个单词首字母大写，如类名StudentCourse。下面是符合该规范的示例程序。

class StudentCourse{

}

2．常量

常量名所有字母大写，单词间用下画线分隔，如常量名NULL、TRUE、FALSE、ROOT_PATH、PI等。下面是符合该规范的示例程序。

<?php

define("PI", 3.1415); //定义常量时，需使用define()函数

?>

3．变量

为了保证软件代码具有良好的可读性，一般要求在同一个软件系统中，变量的命名原则必须统一。例如，同一个软件系统，变量的命名可以为第一个单词首字母小写，其余单词首字母大写（驼峰），如变量名$userID、$userName。教材中有关用户注册系统中定义的变量使用该规则定义变量名。同一个软件系统，变量的命名也可以为单词所有字母小写，单词间用下画线分隔，如变量名$user_id、$student_name。教材中有关新闻发布系统中定义的变量使用该规则定义变量名。

4．数组

数组是一个可以存储多个数组元素的容器，因此在为数组命名时，尽量使用单词的复数形式，如$words、$numbers、$colors、$students、$interests等。

5．函数

函数的命名规范和变量名的命名规范相同。通常函数都是执行一个动作的，因此函数命名时，一般函数名中会包含动词，如函数名getName、setName分别表示取得name值和设置name值。下面是符合该规范的示例程序。

function getName(){

return $this->name;

}

6．数据库表字段

数据库表字段的命名规范和变量名的命名规范相同，如字段名user_id、student_name。

7．类文件

PHP类文件命名时通常以.class.php为后缀，文件名和类名相同，如Student.class.php。

2.3.3 为代码添加注释

软件开发是一种高级脑力劳动，精妙的算法之后往往伴随着难以理解的代码，对于不经常维护的代码，往往连开发者本人也忘记编写的初衷。要为代码添加注释，增强代码的可读性和可维护性。有时添加注释和编写代码一样难，但养成这样的习惯是必要的。请记住：尽最大努力把方便留给别人和将来的自己。