如何创建 PHP 函数的文档说明？

如何创建 PHP 函数的文档说明：使用 @ 符号后跟魔术方法。添加 @param 魔术方法描述参数。添加 @return 魔术方法描述返回值。

如何创建 PHP 函数的文档说明

在 PHP 中，通过使用 @ 符号创建函数文档说明。该符号后跟一个魔术方法（类似于方法），用于提供有关函数的信息。语法如下：

/**
 * @param Type $param1 描述参数 1
 * @param Type $param2 描述参数 2
 * @return Type 描述返回值
 */
function functionName(): Type
{
    // 函数体
}

实战案例：计算两个数的和

以下示例演示了如何为计算两个数和的 PHP 函数创建文档说明：

/**
 * 计算两个数字的和。
 *
 * @param number $num1 第一个数字
 * @param number $num2 第二个数字
 * @return number 和
 */
function addNumbers(int $num1, int $num2): int
{
    return $num1 + $num2;
}

魔术方法列表

常用的魔术方法有：

• @param：描述函数的参数。
• @return：描述函数的返回值。
• @throws：描述函数可能抛出的异常。
• @since：指示函数引入或更改的 PHP 版本。
• @deprecated：标记不再推荐使用的函数。