PHP - 编码标准


每家公司都根据其最佳实践遵循自己的编码标准。编码标准是必需的,因为可能有许多开发人员在不同的模块上工作,所以如果他们开始发明自己的标准,那么源代码将变得非常难以管理,并且将来很难维护该源代码。

以下是应该使用编码规范的一些原因 -

  • 其他程序员必须理解您生成的代码。编码标准充当所有团队破译代码的蓝图。
  • 通过一致的编码实现的简单性和清晰度可以避免常见错误。
  • 如果您在一段时间后修改了代码,那么很容易理解该代码。
  • 遵循统一的编码标准可以提高软件质量。

使用 PHP 编码时可以遵循的准则很少。

缩进和行长

使用 4 个空格的缩进,并且不要使用任何制表符,因为不同的计算机使用不同的制表符设置。建议将行长度保持在 75-85 个字符左右,以提高代码可读性。

控制结构

这些包括 ifforwhileswitch 等。控制语句应在控制关键字和左括号之间有一个空格,以便将它们与函数调用区分开来。强烈建议您始终使用大括号,即使在技术上可选的情况下也是如此。

例子


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'。

使函数可重入

函数不应保留阻止函数可重入的静态变量。

声明块的对齐方式

声明块应对齐。

每行 1 个语句

每行应该只有一个语句,除非这些语句非常密切相关。

简短方法或函数

方法应将自身限制为单个代码页。

在编写 PHP 程序时,可能还应考虑更多要点。总的来说,意图应该是在整个代码编程过程中保持一致,并且只有在您遵循任何编码标准时才有可能。如果您喜欢不同的东西,您可以设置自己的标准。