在 PHP 中注释

在编写代码时，注释是非常有用的一种工具，能够让代码更易于理解和维护。在 PHP 中，我们可以使用多种注释方式来使我们的代码更易读。

单行注释

单行注释以两个斜杠 (//) 开头，在这一行的末尾结束。

// 这是一个单行注释

多行注释

多行注释以 /* 开头，以 */ 结尾。可以跨越多行。

/*
这是一个
多行注释
*/

文档注释

文档注释是一种特殊的多行注释，它被用来生成 API 文档。文档注释以 /** 开头，以 */ 结尾。

/**
 * 这是一个文档注释
 */

文档注释可以包含多个标签，每个标签以 @ 开头。以下是一些常见的标签：

• @param：用于描述函数的参数
• @return：用于描述函数返回值的类型和说明
• @throws：用于描述函数可能抛出的异常

以下是一个带有标签的文档注释的例子：

/**
 * 计算两个数的和
 *
 * @param int $a 第一个数
 * @param int $b 第二个数
 *
 * @return int
 * @throws InvalidArgumentException 如果参数不是整数
 */
function add($a, $b) {
    if (!is_int($a) || !is_int($b)) {
        throw new InvalidArgumentException('参数必须是整数');
    }
    return $a + $b;
}

禁用代码

有时候我们想要禁用一段代码，例如调试时注释掉某一块代码。PHP 提供了两种方式来实现这个目的。

单行禁用代码

单行禁用代码以 # 或 // 开头。

echo '这行代码不会被执行'; // echo '这行代码被禁用了';

多行禁用代码

多行禁用代码以 /* 开头，以 */ 结尾。能够跨越多行。

echo '这行代码不会被执行';
/*
echo '这一段代码被禁用了';
echo '这一段代码被禁用了';
*/

以上就是 PHP 中注释的基本使用方法。使用注释可以让我们的代码更加易读、易懂，并且在持续开发和维护时更加方便。