Php 简明教程

PHP - Coding Standard

每家公司都基于其最佳实践遵循自己的编码规范。编码规范是必需的,因为可能会有许多开发者在研究不同的模块,因此,如果他们开始发明自己的规范,那么源代码将变得非常难以管理,并且在未来难以维护该源代码。

以下是人们应该使用编码规范的部分原因:

  1. 你的同伴程序员必须理解你生成的代码。编码规范可作为团队全体人员解读代码的蓝图。

  2. 通过一致的编码实现的简单性和清晰性让你避免了常见错误。

  3. 如果你在一段时间后修改你的代码,那么该代码变得容易理解。

  4. 遵循统一编码规范会让软件的质量更高。

在使用 PHP 编码时可以遵循一些准则。

Indenting and Line Length

使用 4 个空格的缩进,不要使用任何制表符,因为不同的计算机对制表符使用不同的设置。建议将行长度保持在大约 75-85 个字符以内,以便于更好地阅读代码。

Control Structures

这些内容包括 if、for、while、switch 等。控制语句在控制关键字和开括号之间应该有一个空格,以区别于函数调用。强烈建议你始终使用大括号,即使在技术上它们是可选项的情况下也是如此。

Examples

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

Function Calls

函数调用时不应该在函数名称、开括号和第一个参数之间使用空格;在逗号和每个参数之间使用空格;在最后一个参数、闭括号和分号之间不使用空格。以下是一个示例:

$var = foo($bar, $baz, $quux);

Function Definitions

函数声明遵循“BSD/Allman 样式”:

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

Comments

C 风格注释 (/* */) 和标准 C++ 注释 (//) 都可以。允许使用 Perl/shell 风格注释 (#),但不鼓励这样做。

PHP Code Tags

始终使用 <?php ?> 来分隔 PHP 代码,而不是 <? ?> 简写。这是 PHP 合规性要求,也是在不同的操作系统和设置上包含 PHP 代码的最可移植方式。

Variable Names

  1. 全部使用小写字母

  2. 使用“_”作为单词分隔符。

  3. 全局变量应该以“g”为前缀。

  4. 全局常量应该全部大写,并使用“_”作为分隔符。

  5. 静态变量可以预先加上“s”。

Make Functions Reentrant

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

Alignment of Declaration Blocks

声明块应对齐。

One Statement Per Line

除了语句紧密相关之外,每行只能有一个语句。

Short Methods or Functions

方法应限制在单个代码页中。

在编写 PHP 程序时,应考虑很多要点。总的来说,意图应始终一致,并且仅在遵循编码标准时才有可能。如果你喜欢不同的东西,你可以设计自己的标准。