0

0

PHP怎么注释类_PHP类注释规则【必知】

蓮花仙者

蓮花仙者

发布时间:2026-01-16 20:12:32

|

873人浏览过

|

来源于php中文网

原创

php类注释必须使用标准phpdoc格式(/* /),正确标注@param、@return、@property、@method等标签,否则影响ide补全、静态分析和文档生成。

php怎么注释类_php类注释规则【必知】

PHP 类注释不是可有可无的装饰,而是 IDE 补全、PHPStan/ Psalm 静态分析、生成文档(如 phpDocumentor)的前提。没写对 @param 或漏掉 @returnphpstan 就可能报错,PhpStorm 也识别不出返回类型。

类声明上方必须用 PHPDoc 块注释

不能用单行 // 或多行 /* */ 替代。只有以 /** 开头、每行以 * 对齐、以 */ 结尾的块,才会被解析为 PHPDoc。

  • 错误写法:
    /* 这是普通注释,不会被解析 */<br>class UserService {}
  • 正确写法:
    /** <br> * 用户服务类,负责用户注册、登录和信息更新<br> */<br>class UserService {}
  • @package@author 不强制,但团队协作中建议统一加 @package(如 @package App\Services),方便后续生成文档结构

@property 和 @method 必须写在类级 PHPDoc 中

这两个标签只在类声明正上方的 PHPDoc 块里生效,用于描述“魔术属性”或“动态方法”,比如 Laravel 的 Eloquent 模型或使用 __get/__call 的类。

Lemonaid
Lemonaid

AI音乐生成工具,在音乐领域掀起人工智能革命

下载
  • @property 告诉 IDE 和静态分析器:这个类虽无真实属性,但能读写 $user->name
    /** <br> * @property string $name<br> * @property int $age<br> */<br>class User { ... }
  • @method 用于声明动态方法签名,否则调用 $user->scopeActive()->get() 时 IDE 会标红
    /** <br> * @method static User query()<br> * @method User active()<br> */<br>class User extends Model {}
  • 注意:这些标签不改变运行时行为,只是“告诉工具该这么理解”,写错类型(如把 @property int $id 写成 @property string $id)会导致 IDE 提示错误或静态分析误报

构造函数参数必须用 @param 显式标注

PHP 8+ 支持构造函数属性提升(public function __construct(public string $name)),但即使如此,仍需在类级 PHPDoc 中用 @param 描述每个参数——因为 PHPDoc 是给开发者和工具看的,不是给 PHP 解析器看的。

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

  • 哪怕用了属性提升,也要补全:
    /** <br> * @param string $name 用户姓名<br> * @param int $level 权限等级,默认 1<br> */<br>class User {<br>    public function __construct(<br>        public string $name,<br>        public int $level = 1<br>    ) {}<br>}
  • 如果参数是联合类型(如 string|null),@param 必须写全:@param string|null $email,不能简写为 @param string $email
  • PHP 8.0+ 的 mixed 类型要显式写 @param mixed $data,否则部分工具(如 PHPStan level 6+)会警告“缺少类型信息”

最常被忽略的是:类注释里的 @return 是留给静态方法的,不是给类本身用的;而 @var 只能用于变量赋值行上方,不能放在类 PHPDoc 里。混淆这些位置,注释就彻底失效了。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

338

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

290

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

708

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

384

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

135

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

82

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

75

2025.08.05

phpstorm怎么导出项目
phpstorm怎么导出项目

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

382

2024.04.08

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

3

2026.03.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号