PHP 编码规范
每家公司都遵循不同的编码规范,基于他们的最佳实践。编码规范是必需的,因为可能有许多开发人员在不同的模块上工作,如果他们开始发明自己的规范,源码将变得难以管理,并且将难以在将来维护该源代码。
以下是使用编码规范的几个原因:
- 你的同行程序员必须理解你编写的代码。编码规范作为整个团队解读代码的蓝图。
-
一致的编码所带来的简洁和清晰性可以避免常见的错误。
-
如果你在一段时间后修改代码,那么很容易理解那段代码。
-
按照特定的标准来进行更高质量的软件开发是业界的标准。
在编写PHP代码时,可以遵循以下几个指导原则:
- 缩进和行长度 - 使用4个空格进行缩进,不要使用制表符,因为不同的计算机使用不同的制表符设置。建议将代码行的长度保持在75-85个字符左右,以提高代码的可读性。
-
控制结构 - 包括if、for、while、switch等。控制语句的关键字与开括号之间应有一个空格,以区分它们和函数调用。在技术上可选的情况下,强烈建议始终使用花括号。
示例
if ((condition1) || (condition2)) {
action1;
}elseif ((condition3) && (condition4)) {
action2;
}else {
default action;
}
你可以如下编写switch语句−
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
- 函数调用 - 函数应该在函数名、开括号和第一个参数之间没有空格,而在逗号和每个参数之间有空格,在最后一个参数、闭括号和分号之间没有空格。以下是一个示例 –
$var = foo($bar, $baz, $quux);
- 函数定义 - 函数声明遵循“BSD/Allman样式” –
function fooFunction(arg1,arg2 = '') {
if (condition) {
statement;
}
return $val;
}
- 注释 − C风格注释(
/* */
)和标准C++注释(//
)都可以使用。不鼓励使用Perl/Shell风格的注释(#
)。 -
PHP代码标签 − 始终使用
<?php ?>
来界定PHP代码,而不是<? ?>
的简写形式。这是为了符合PHP规范,也是在不同操作系统和设置上包含PHP代码的最具可移植性的方式。 -
变量命名 −
- 使用全部小写字母
- 使用’
_
‘作为单词分隔符 - 全局变量应该以’
g
‘开头 - 全局常量应该全部大写,并用’
_
‘分隔 - 静态变量可以以’
s
‘开头
- 使函数可重入 − 函数不应该保留阻止函数可重入的静态变量。
-
声明块对齐 − 声明块应该对齐。
-
每行只有一个语句 − 每行应该只有一个语句,除非这些语句非常密切相关。
-
简短的方法或函数 − 方法应该限制在一页代码内。
编写PHP程序时应考虑更多要点。总体的目标是在整个代码编程中保持一致,只有遵循某种编码标准才能实现。如果你喜欢不同的标准,可以制定自己的标准。