讲师中心 微信公众号
AI工具推荐 视频效率加速

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

落强吖_7701

落强吖_7701

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

|

625人浏览过

|

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

VS Code Node
VS Code Node

通过作为 OpenClaw 节点连接的 VS Code/Cursor IDE 操作代码,提供 40 多种命令,涵盖文件操作、语言智能、Git、测试等功能。

下载
  • 每个可能抛出的自定义异常都单独写一行 @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怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

1208

2024.04.08

phpStorm怎么运行
phpStorm怎么运行

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

4598

2025.09.18

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

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

4976

2025.09.18

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

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

1881

2025.09.18

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

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

98

2026.01.15

从环境搭建到代码调试:PHPstorm全流程开发配置指南
从环境搭建到代码调试:PHPstorm全流程开发配置指南

本文旨在为PHP开发者提供一份详尽的PhpStorm全流程开发配置指南。内容涵盖从IDE安装、PHP解释器配置、Xdebug调试环境搭建,到项目运行与断点调试的完整流程。通过本指南,读者将掌握搭建高效开发环境的核心技能,快速上手PhpStorm的强大功能,显著提升PHP开发效率。

61

2026.04.01

PHPstorm编辑器全系统安装与激活配置指南
PHPstorm编辑器全系统安装与激活配置指南

本文提供一份详尽的PHPstorm全系统安装与激活配置指南,覆盖Windows、macOS及Linux三大主流平台。内容从官方安装包的获取、安装过程中的路径与组件选择,到激活流程(包括正版激活与补丁替换法)均有详细图解。此外,指南还包含安装后的基础环境配置与中文语言包安装,旨在帮助开发者快速完成IDE部署,为PHP开发搭建一个稳定、高效的集成环境。

196

2026.04.01

ps软件新手入门教程合集
ps软件新手入门教程合集

PHP中文网精心打造了本PS新手入门教程合集。内容涵盖软件安装、界面认知、图层管理及抠图调色等核心技能,提供从零基础到精通的系统化学习路径。无论您是想快速上手修图还是进阶平面设计,都能在此找到实用指南与实战案例,助您轻松玩转Photoshop。

760

2026.06.11

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

20

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn