缩进与空白字符(Indenting and Whitespace)
使用 2 个空格而不使用 tab 键进行代码缩进(notepad++, Eclipse 等编辑器均支持此项配置);
行尾不应该有空白字符
应使用 \n (Unix换行符),而不是 \r\n (Windows 换行符)
所有文件均应以一个空行结尾
运算符(Operators)
所有二元运算符(二个值之间的运算符),如 +, -, =, !=, ==, > 等等,在运算符两端均需留有一个空格,如应该使用 $foo = $bar 而不是 $foo=$bar。
所有一元运算符(只操作一个值班的运算符),例如 ++,在值与运算符之间则不应加入空格
转型(Casting)
在 (type) 与要转型的变量之间应加入一个空格,如 (int) $mynumber.
控制结构(Control Structures)
控制结构包含 if, for, while, switch 等等,下面是一个简单的 if 语句结构示例:
复制代码 代码如下:
if (condition1 || condition2) {
action1;
}
elseif (condition3 && condition4) {
action2;
}
else {
defaultaction;
}
(Note: 不要使用 "else if" -- 总是使用 elseif.)
控制语句的关键词与左边括号之间应该有一个空格,以此来与函数调用进行区分。
即使在大括号是可选的情况下,也应当总是使用大括号。这样可以加强代码的可读性以及减少因嵌套带来的逻辑错误。
switch 语句结构示例:
复制代码 代码如下:
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
}
do-while 语句结构示例:
do {
actions;
} while ($condition);
行长度与封装(Line length and wrapping)
通常情况下,每行代码的长度不应超过80个字符
以下情况,行长度可超过80个字符:当行内包含过长的函数名称、函数/类定义、变量声明等
为方便阅读和理解,控制结构的行长度可超过80个字符
复制代码 代码如下:
if ($something['with']['something']['else']['in']['here'] ==
mymodule_check_something($whatever['else'])) {
...
}
if (isset($something['what']['ever']) && $something['what']['ever'] > $infinite
&& user_access('galaxy')) {
...
}
// Non-obvious conditions of low complexity are also acceptable, but should
// always be documented, explaining WHY a particular check is done.
if (preg_match('@(/|\\)(\.\.|~)@', $target) && strpos($target_dir, $repository)
!== 0) {
return FALSE;
}
控制条件(condition)不应该写作多行
控制条件应该适当拆分以便于阅读和理解,编写代码时要避免以下情形:
复制代码 代码如下:
// DON'T DO THIS!
if ((isset($key) && !empty($user->uid) && $key == $user->uid) || (isset($user-
>cache) ? $user->cache : '') == ip_address() || isset($value) && $value >= time()))
{
...
}
将控制条件进行拆分,不仅便于阅读,同时也方便添加注释让人知道为何进行这样的条件判断
复制代码 代码如下:
// Key is only valid if it matches the current user's ID, as otherwise other
// users could access any user's things.
$is_valid_user = (isset($key) && !empty($user->uid) && $key == $user->uid);
// IP must match the cache to prevent session spoofing.
$is_valid_cache = (isset($user->cache) ? $user->cache == ip_address() : FALSE);
// Alternatively, if the request query parameter is in the future, then it
// is always valid, because the galaxy will implode and collapse anyway.
$is_valid_query = $is_valid_cache || (isset($value) && $value >= time());
if ($is_valid_user || $is_valid_query) {
...
}
函数调用(Function Calls)
调用函数时,函数名与左括号之间没有空格,除最后一个参数外,每个参数后的 , 都应跟上一个空格,如:
$var = foo($bar, $baz, $quux);
如之前所说,等号两边应该各有一个空格。当有一系列相关语句时,出于可读性的考虑,可以适当增加空格的数量,如:
$short = foo($bar);
$long_variable = foo($baz);
函数声明(Function Declarations)
包含默认值的参数应当放在最后,当函数拥有返回值时,尽量返回便于理解的值:
复制代码 代码如下: