php 函数文档中异常描述规范：格式：@throws |exception name| exception descriptionexception name：异常类的完全限定名称exception description：使用完整句子描述异常原因，避免模糊措辞
PHP 函数文档异常描述规范
在 PHP 函数文档中，异常的描述应遵循以下规范：
描述格式：
立即学习“PHP免费学习笔记（深入）”；
@throws |Exception Name| Exception description
Exception Name：
- 异常类的完全限定名称。
- 在 PHP 8.0 及更高版本中，允许使用
Throwable作为基类。
Exception description：
- 使用完整的句子清晰准确地描述异常。
- 尽可能提供有关异常原因的详细信息。
- 避免使用模棱两可或模糊的措辞。
实战案例：
以下示例演示了异常描述的正确格式：
/**
* 打开一个文件。
*
* @param string $filename 文件名
* @param string $mode 打开模式
* @return resource 打开的文件指针
*
* @throws \Exception 文件无法打开时抛出。
*/
function fopen(string $filename, string $mode): resource
{
// ...
throw new \Exception("无法打开文件：$filename");
}注意：
- 异常描述应该足够详细，便于开发人员理解并处理异常。
- 异常描述应避免使用技术术语，除非它们对于理解异常至关重要。
- 如果函数可以抛出多个异常，应为每个异常提供单独的描述。
