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免费学习笔记(深入)”;

VIVA
VIVA

一个免费的AI创意视觉设计平台

下载
  • 每个可能抛出的自定义异常都单独写一行 @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 状态码、支付网关返回码,还是内部枚举值。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
phpstorm怎么导出项目
phpstorm怎么导出项目

phpstorm提供导出项目功能,步骤如下:打开phpstorm项目转到“项目”菜单选择“导出项目”选择导出格式指定导出位置选择导出范围勾选“包括依赖项”框(可选)单击“导出”完成导出。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

387

2024.04.08

phpStorm怎么运行
phpStorm怎么运行

本专题整合了phpstorm运行教程,阅读专题下面的文章了解更多相关内容。

89

2025.09.18

phpstorm开发环境搭建教程
phpstorm开发环境搭建教程

本专题整合了phpstorm开发环境搭建和运行项目教程,阅读专题下面的文章了解更多详细教程。

78

2025.09.18

phpstorm怎样运行php
phpstorm怎样运行php

本专题整合了phpstorm运行php相关教程,阅读专题下面的文章了解更多详细内容。

62

2025.09.18

phpstorm相关教程大全
phpstorm相关教程大全

本专题整合了phpstorm相关教程汇总,阅读专题下面的文章了解更多详细内容。

23

2026.01.15

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1010

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

共12课时 | 0.7万人学习

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

共33课时 | 2.2万人学习

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

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