php 注释用于向代码添加元数据，包括文档记录、添加框架特定信息以及启用代码重构。有三种主要的注释类型：单行注释、多行注释和文档注释。文档注释遵循 docblock 格式，用于生成文档。要使用注释，只需在代码前添加相应注释标记。常用注释包括：@param、@return、@throws、@var 和 @deprecated。可以使用各种工具来分析和使用 php 注释，例如 phpdoc、phan 和 psalm。

PHP 注解

PHP 注解是一种元数据，它可以添加到类、方法、函数和属性上，为代码提供额外信息。注释主要用于以下目的：

• 记录文档：用于生成代码文档、帮助和 API 参考。
• 添加元数据：用于添加特定于框架或库的信息，如路由或验证规则。
• 启用代码重构：例如，添加类型提示以启用自动完成和重构工具。

PHP 中的注释类型

PHP 中有三种主要的注释类型：

立即学习“PHP免费学习笔记（深入）”；

• 单行注释：以 // 开头，延续一行。
• 多行注释：以 /* 开头，以 */ 结束，跨越多行。
• 文档注释：以 /** 开头，以 */ 结束。文档注释遵循 DocBlock 格式，用于生成文档。

使用注释

要使用注释，只需在代码之前添加相应的注释标记即可。例如：

/**
 * 计算两个数字的总和
 *
 * @param int $a 第一个数字
 * @param int $b 第二个数字
 * @return int 总和
 */
function sum(int $a, int $b): int
{
    return $a + $b;
}

常用 PHP 注解

以下是 PHP 中一些常用的注解：

• @param：指定函数或方法参数的类型和描述。
• @return：指定函数或方法的返回值类型和描述。
• @throws：指定函数或方法可能抛出的异常类型和描述。
• @var：指定属性的类型和描述。
• @deprecated：表示函数或方法已弃用。

使用注释工具

可以使用各种工具来分析和使用 PHP 注解，例如：

• [PHPDoc](https://www.phpdoc.org/)
• [Phan](https://phan.dev/)
• [Psalm](https://psalm.dev/)