PHP - 编程规范

你好，未来的 PHP 开发者们！我很高兴能引导你们进入 PHP 编程规范的迷人世界。作为一位有着多年教学经验的编程讲师，我可以向你们保证，掌握这些规范将使你们的代码更加整洁、易读且更专业。让我们开始吧！

PHP - Coding Standard

缩进与行长度

适当的缩进就像是编程中的好习惯 - 它让一切变得更加愉快且易于理解。在 PHP 中，我们通常为每个缩进级别使用 4 个空格。以下是一个例子：

<?php
if ($condition) {
echo "这行代码被缩进了";
if ($another_condition) {
echo "这行代码缩进更多";
}
}

在这个例子中，第一个 echo 语句缩进了一次（4 个空格），第二个 echo 语句缩进了两次（8 个空格）。这种视觉层次帮助我们快速理解代码结构。

至于行长度，尽量保持你们的行数不超过 80 个字符。如果一行太长，像这样将其分成多行：

$very_long_variable_name = $another_long_variable_name
+ $yet_another_long_variable_name
+ $one_more_long_variable_name;

控制结构

控制结构是你们程序逻辑的构建块。在 PHP 中，最常见的是 if、else、elseif、while、for 和 switch。以下是如何正确格式化它们：

if ($condition1) {
// 在这里编写代码
} elseif ($condition2) {
// 在这里编写更多代码
} else {
// 在这里编写更多代码
}

while ($condition) {
// 要重复的代码
}

for ($i = 0; $i < 10; $i++) {
// 要重复的代码
}

switch ($variable) {
case 1:
// case 1 的代码
break;
case 2:
// case 2 的代码
break;
default:
// 默认代码
break;
}

注意每个代码块都是用大括号 {} 包围且正确缩进的。

函数调用

在调用函数时，函数名和左括号之间不应有空格。以下是如何正确编写：

$result = myFunction($arg1, $arg2);

如果函数调用太长，可以将其分成多行：

$result = myVeryLongFunctionName(
$arg1,
$arg2,
$arg3,
$arg4
);

函数定义

定义函数时，遵循以下格式：

function myFunction($arg1, $arg2 = null)
{
// 函数体
}

注意，左大括号 { 是在新一行上的。这被称为"Allman风格"，在 PHP 中很常见。

注释

注释对于解释你们的代码至关重要。请慷慨使用！以下是 PHP 中的注释类型：

// 这是一个单行注释

/*
这是一个多行注释。
它可以跨越多行。
*/

/**
* 这是一个 DocBlock 注释。
* 它用于记录函数、类等。
*
* @param string $arg1 第一个参数的描述
* @return bool 函数返回值的描述
*/
function myDocumentedFunction($arg1)
{
// 函数体
}

PHP 代码标签

编写 PHP 代码时，总是使用完整的 PHP 标签：

<?php
//你们的 PHP 代码在这里
?>

避免使用短标签 <?，因为它们并非在所有服务器上都启用。

变量命名

变量名应该具有描述性，并使用小写字母和下划线（snake_case）：

$user_name = "John";
$total_items = 5;

对于常量，使用全部大写字母和下划线：

define('MAX_USERS', 100);

使函数可重入

可重入函数是指在执行过程中可以被中断，然后可以安全地再次调用的函数。为了实现这一点，避免在函数中使用全局变量或静态变量。以下是一个例子：

// 不可重入
function badCounter()
{
static $count = 0;
return ++$count;
}

// 可重入
function goodCounter($count)
{
return ++$count;
}

声明块的排列

在声明多个变量时，对齐它们以提高可读性：

$short        = 1;
$long_variable = 2;
$longer_variable = 3;

每行一个语句

为了清晰起见，每行只放一个语句：

$a = 1;
$b = 2;
$c = 3;

避免：

$a = 1; $b = 2; $c = 3; // 这更难阅读

短方法或函数

保持你们的函数简短且专注于单一任务。一般来说，如果一个函数超过 20-30 行，考虑将其分解为更小的函数。

以下是我们讨论过的一些关键 PHP 编程规范的总结表：

规范	示例
缩进	使用 4 个空格
行长度	保持 80 个字符以下
函数调用	`myFunction($arg1, $arg2);`
函数定义	`function myFunction($arg1, $arg2) { ... }`
变量命名	使用 snake_case: `$user_name`
常量	使用 UPPER_CASE: `MAX_USERS`
注释	使用 `//`、`/* /` 或 `/* */`
PHP 标签	总是使用 `<?php ?>`

请记住，这些规范不是任意的规则。它们是 PHP 社区多年来开发出来的最佳实践，以使代码更加可读和维护。通过遵循这些标准，你们不仅仅是编写代码 - 你们还在与可能在未来工作于你们代码的其他开发者进行沟通。而且，谁知道呢？那位未来的开发者可能就是你们自己！

在我们结束之前，我想起了一位学生曾经对我说的话，“学习编程规范就像学习餐桌礼仪。一开始看起来很麻烦，但一旦你习惯了，你就会想知道没有它们你之前是如何生活的！”所以，继续练习这些规范，很快它们就会成为你们的第二天性。祝你们编程愉快！

Credits: Image by storyset