3.2 编码规范
由于现在的Web开发往往是多人一起合作完成的,因此使用相同的编码规范显得非常重要,特别是新的开发人员参与时,通常需要知道前面开发代码中变量或函数的作用等,这就需要统一的编码规范。
3.2.1 什么是编码规范
编码规范是一套某种编程语言的导引手册,规定了一系列语言的默认编程风格,以增强语言的可读性、规范性和可维护性。一个语言的编码规范主要包括文件组织、缩进、注释、声明、空格处理、命名规则等。
遵守编码规范有以下好处。
· 编码规范是团队开发中对每个成员的基本要求。编码规范的好坏是一个程序员成熟程度的表现。
· 提高程序的可读性,有利于开发人员互相交流。
· 良好一致的编程风格,在团队开发中可以达到事半功倍的效果。
· 有助于程序的维护,降低软件成本。
3.2.2 PHP中的编码规范
PHP作为一种高级语言,十分强调编码规范。
1.表述
在PHP的正常表述中,每一条PHP语句都是以“;”结尾的,这个规范就告诉PHP要执行此语句,例如:
<?php echo "php以分号表示语句的结束和执行。"; ?>
2.指令分隔符
在PHP代码中,每个语句后需要用分号结束命令。一段PHP代码中的结束标记隐含表示了一个分号,所以在PHP代码段的最后一行可以不用分号结束,例如:
<?php echo "这是第一个语句"; // 每条语句都加入分号 echo "这是第二个语句"; echo "这是最后一个语句"?> // 结束标记“?>”隐含了分号,这里可以省略分号
3.空白符
PHP对空格符、回车符造成的新行、制表符(Tab)等留下的空白处理也遵循编码规范。PHP会忽略它们。这和浏览器对HTML语言中的空白处理是一样的。
在程序中合理利用空白可以增强代码的可读性和清晰性。
(1)下列情况应该总是使用两个空白行:
①两个类的声明之间。
②一个源文件的两个代码片段之间。
(2)下列情况应该总是使用一个空白行:
①两个函数声明之间。
②函数内的局部变量和函数的第一条语句之间。
③块注释或单行注释之前。
④一个函数内的两个逻辑代码段之间。
(3)合理利用空格缩进可以提高代码的可读性。
①空格通常用于关键字与括号之间,但是函数名称与左括号之间不能使用空格分开。
②函数参数列表中的逗号后面通常会插入空格。
③ for语句的表达式应该用逗号分开,后面添加空格。
4.注释
为了增强可读性,在很多情况下,程序员都需要在程序语句的后面添加文字说明,而PHP要把它们与程序语句区分开,需要让这些文字注释符合编码规范。
这些注释的风格包括C语言风格、C++风格和SHELL风格。
(1)C语言风格如下:
/*这是C语言风格的注释内容*/
这种方法还可以多行使用:
/*这是 C语言风格 的注释内容 */
(2)C++风格如下:
//这是C++风格的注释内容行一 //这是C++风格的注释内容行二
(3)SHELL风格如下:
#这是SHELL风格的注释内容
C++风格和SHELL风格只能一条注释语句占用一行,这类注释既可单独占用一行,也可放在PHP语句之后的同一行内。
5.与HTML语言混合搭配
凡是在一对PHP开始和结束标记之外的内容都会被PHP解析器忽略,这使得PHP文件可以具备混合内容,使PHP嵌入HTML文档中,例如:
<HTML> <HEAD> <TITLE>PHP与HTML混合</TITLE> </HEAD> <BODY> <?php echo "嵌入的PHP代码"; ?> </BODY> <HTML>