0

0

PHP怎么注释自定义异常_PHP自定义异常注释【专属】

絕刀狂花

絕刀狂花

发布时间:2026-01-19 19:58:56

|

605人浏览过

|

来源于php中文网

原创

自定义异常类需在类上方用标准DocBlock注释,明确语义、@see触发方法及@property声明属性;方法中须逐行@throws具体异常类名(含命名空间);PHP 8.0+属性提升后仍需@propert声明以保障语义清晰。

php怎么注释自定义异常_php自定义异常注释【专属】

PHP自定义异常类怎么写 DocBlock 注释

PHP 自定义异常类本身是 Exception 的子类,注释重点不是“加不加”,而是**是否准确描述了异常语义和抛出上下文**。直接在类定义上方用标准 DocBlock 即可,不需要特殊语法。

常见错误是只写 /** @throws MyCustomException */ 在方法里,却忘了给异常类本身写说明——这会让 IDE 和静态分析工具(如 PHPStan、Psalm)无法理解这个异常代表什么业务含义。

  • 必须用 /** ... */ 块注释,不能用 //
  • 首行简明说明异常用途,比如“用户余额不足时抛出”
  • 推荐补充 @see 指向触发该异常的具体方法或业务流程
  • 如果异常携带额外属性(如错误码 $errorCode),需用 @property 明确声明
/**
 * 用户余额不足以完成支付时抛出
 * @see PaymentService::process()
 * @property int $errorCode 错误码,例如 402 表示余额不足
 */
class InsufficientBalanceException extends Exception
{
}

throw new 时要不要在方法里 @throws 注释

要,而且必须对应到具体异常类名。PHP 不强制检查 @throws,但现代 IDE(PhpStorm、VS Code + Intelephense)和类型分析工具依赖它做跳转、提示和未捕获异常检测。

容易踩的坑:@throws Exception 这种宽泛写法等于没写——它掩盖了真实异常契约,导致调用方无法针对性 catch 或写单元测试。

立即学习PHP免费学习笔记(深入)”;

  • 每个可能抛出的自定义异常都单独写一行 @throws
  • 如果方法既抛 InsufficientBalanceException 又抛 InvalidPaymentMethodException,就写两行
  • 不要省略命名空间,如 @throws \App\Exceptions\InsufficientBalanceException
/**
 * @throws \App\Exceptions\InsufficientBalanceException
 * @throws \App\Exceptions\InvalidPaymentMethodException
 */
public function charge(float $amount): void
{
    if ($this->balance < $amount) {
        throw new InsufficientBalanceException('余额不足');
    }
}

自定义异常构造函数参数要不要注释

要,尤其是当重写了 __construct() 并添加了新参数时。PHP 原生 Exception 构造函数签名是 __construct(string $message = "", int $code = 0, ?Throwable $previous = null),如果你新增了 $context$retryAfter,就必须文档化。

无涯·问知
无涯·问知

无涯·问知,是一款基于星环大模型底座,结合个人知识库、企业知识库、法律法规、财经等多种知识源的企业级垂直领域问答产品

下载

否则调用方传参会困惑,IDE 也无法提示参数名和类型。

  • @param 注释每个新增参数
  • 原生参数($message, $code)可不重复注释,除非你改变了语义(比如把 $code 改成 HTTP 状态码
  • 若仅调用 parent::__construct(...) 且无新增参数,无需重写构造函数,更无需额外注释
/**
 * @param string $message 错误信息
 * @param int $code 业务错误码(非 PHP 异常 code)
 * @param array $context 关联上下文数据,如 ['order_id' => 123]
 */
public function __construct(string $message, int $code, array $context = [])
{
    parent::__construct($message, $code);
    $this->context = $context;
}

PHP 8.0+ 属性提升后,@property 注释还有效吗

仍然有效,而且更关键。PHP 8.0 引入属性提升(promoted properties),比如 public function __construct(public int $errorCode),此时 $errorCode 是公开属性,但 PHPDoc 不会自动推导其用途和业务含义。

静态分析工具(如 Psalm)默认不信任提升属性的语义,必须靠 @property 显式声明,否则会报 PropertyNotSetInConstructor 或无法识别字段作用。

  • 即使用了属性提升,也要在类 DocBlock 中补 @property int $errorCode 业务错误码
  • @property-read@property-write 可用于限定访问权限(尽管运行时不受限)
  • 别依赖 IDE 自动生成的 @property——它常漏掉描述,或把类型写成 mixed

最易忽略的一点:很多人给异常类写了完整 DocBlock,却在重构时删掉了 @property 行,导致后续团队成员无法快速理解那个 $errorCode 到底是 HTTP 状态码、支付网关返回码,还是内部枚举值。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2684

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1661

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1518

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1419

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1488

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

PHP基础入门课程
PHP基础入门课程

共33课时 | 2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号