PHP编码规范的深入分析

这篇文章主要为大家详细介绍了PHP编码规范的深入分析，具有一定的参考价值，可以用来参考一下。

感兴趣的小伙伴，下面一起跟随php教程的小玲来看看吧！

缩进与空白字符（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;
}

代码如下:

switch (condition) {
  case 1:
    action1;
    break;
  case 2:
    action2;
    break;
  default:
    defaultaction;
}
do-while 语句结构示例：
do {
  actions;
} while ($condition);

代码如下:

  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;
  }

代码如下:

// 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 Declarations）包含默认值的参数应当放在最后，当函数拥有返回值时，尽量返回便于理解的值：

代码如下:

function funstuff_system($field) {
  $system["description"] = t("This module inserts funny text into posts randomly.");
  return $system[$field];
}

带参数的类构造器$foo = new MyClassName($arg1, $arg2);如果使用变量做为类名，需先为变量赋值，然后才调用类构造器：

代码如下:

$bar = 'MyClassName';
$foo = new $bar();
$foo = new $bar($arg1, $arg2);

代码如下:

$form['title'] = array(
  '#type' => 'textfield',
  '#title' => t('Title'),
  '#size' => 60,
  '#maxlength' => 128,
  '#description' => t('The title of your node.'),
);

字符串连接（String Concatenations）在点与要连接字符串之间需要加入空格以加强代码可读性：如果只是简单地连接变量，可以使用双引号使用连接赋值符（.=）时，需要在符号两侧预留空格注释（Comment）注释规范单独在 Doxygen及注释格式规范页面 讨论引入代码（Including Code）任何无条件引用文件的情况下，使用 require_once(), 任何有条件引用文件的情况，则使用 include_once(). 这两条语句都会保证文件只被引入一次。当从当前目录或子目录引入代码时，始终以点路径开头include_once ./includes/mymodule_formatting.inc在 Drupal 7 及更新版本中，使用 DRUPAL_ROOT 常量：require_once DRUPAL_ROOT . '/' . variable_get('cache_inc', 'includes/cache.inc');PHP 代码标签（PHP Code Tags）始终使用<?php /* php教程 www.512Pic.com */ ?>来界定PHP代码而不使用要<? ?>。这是为了遵循Drupal规范，同时也便于代码在其它系统和平台中被引用。自 Drupal 4.7 开始，最后的 ?> 都故意被忽略不写，原因如下：移除它可以避免在文件末尾出现空白字符，这些空白字符可能导致“文件头已发送（header already sent）”错误，XHTML/XML验证错误，及其它问题PHP 官方说明 结尾的PHP界定符是可选项PHP.net 自身也移除了文件末尾的界定符（如 prepend.inc ）

分号（Semicolons）PHP 语言要求除了代码块以外，大多数行尾都要跟上分号。Drupal 代码规范同样有此要求，并且对于代码块也是如此。以下是一个单行代码块的示例：-- YES-- NO示例 URL（Example URL）使用 example.com 表示所有示例 URLs命名规范（Naming Conventions）函数与变量（Functions and Variables）函数与变量名称应该使用小写字母，且单词之间使用下划线分隔。函数应该使用模块组/模块名称作为前缀，以避免与不同模块间的冲突。持久变量（Persistent Variables）持久变量是指通过 variable_get()/variable_set() 函数取得和设置的变量，变量名称应该使用小写字母，且单词之间使用下划线进行分隔。持久变量也应该使用模块组/模块名称作为前缀，以避免与不同模块间的冲突。

常量（Constants）常量始终要求使用全大写字母，且单词之间使用下划线进行分隔。（包括PHP内置常量 TRUE, FALSE, NULL）模块中定义的常量需始终使用大写的模块名称作为前缀。在 Drupal 8 及之后，应使用 const 关键词代替 define() 函数来定义常量，因为效率更高注意 const 不能用于PHP表达式，因此在条件判断和非字面值（non-literal value ???）时，还是应当使用 define() 函数全局变量（Global Variables）定义全局变量时，应当使用下划线加模块/主题名称开头类（Class）类名应使用驼峰式命名（即单词首字母大写）类中的方法（函数）和属性（成员变量）应使用首字母小写的驼峰式定义访问权限时，使用 protected 而代替 private，从而其它的类可以在必要时扩展和更新方法。Protected 和 public 函数和变量不应以下划线开头。更多关于 面向对象的编码规范文件名（Filename）所有文档文件都应加上 .txt 后缀，以便于 Windows 用户查看。同时，所有文件名称应该全部大写，而文件后缀应该全部小写。如 README.txt, INSTALL.txt, TODO.txt, CHANGELOG.txt 等等。

辅助模块及工具Coder 模块：可以遵循部分以上代码规范，对代码进行审查及修改建议Drupal Code Sniffer ：代码规范检测工具PAReview.sh ：还处理沙盒中的代码规范检测脚本，几乎严格遵守以上所有代码规范并给出修改建议。

注：关于PHP编码规范的深入分析的内容就先介绍到这里，更多相关文章的可以留意