讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

Laravel文档完善版本差异:Laravel 10+中使用PHP属性替代注释生成文档【说明】

浅静大大_1190

浅静大大_1190

发布时间:2026-06-04 22:42:17

|

939人浏览过

|

来源于php中文网

原创

PHP 属性在 Laravel 10+ 中无法被 Scribe 或 l5-swagger 等主流文档工具直接解析生成 API 文档,仍需依赖传统 PHPDoc 注释(如 @bodyParam、@OA\Get);仅 FormRequest 中的 rules() 可被 Scribe 自动提取,属性本身不参与文档生成。

laravel文档完善版本差异:laravel 10+中使用php属性替代注释生成文档【说明】

在 Laravel 10+(尤其搭配 PHP 8.1+)项目中,PHP 属性(Attributes)正逐步替代传统 PHPDoc 注释用于描述接口行为,但目前主流文档生成工具尚未原生支持属性语法直接生成 API 文档。这不是 Laravel 的“新特性”,而是生态适配的现实断层——你写对了属性,工具却读不到。

为什么 @OA\Get 或 @bodyParam 注释仍不可弃

Scribe(当前最推荐的 Laravel 文档工具)和 darkaonline/l5-swagger 都不解析 PHP 属性,它们依赖传统 DocBlock 中的特定标签:

  • @bodyParam name string required → 被 Scribe 自动提取为请求体字段
  • @OA\Get(path="/users") → 被 l5-swagger 解析为 OpenAPI 操作对象
  • #[Validate(['name' => 'required|string'])] → Scribe 能识别 FormRequest 类里的 rules(),但不会读取这个属性本身

也就是说:即使你在控制器方法上写了 #[MapResource(UserResource::class)] 或 #[Middleware('auth:sanctum')],这些信息不会自动出现在生成的文档里,除非你用对应注释显式声明(如 @authenticated、@response)。

哪些属性能被间接利用?

部分属性虽不直出文档,但可被工具链“感知”:

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载

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

  • #[Validate] 和 #[ValidateIf]:Scribe 不读它们,但如果你把验证逻辑封装进 FormRequest 类,并在控制器中使用该类(store(StoreUserRequest $request)),Scribe 就能自动读取其 rules() 方法并生成参数说明
  • #[ScopeBindings] 或 #[WithoutModelEvents]:纯运行时行为,与文档无关,无需注释补充
  • #[OnQueue] 等队列属性:API 文档不体现异步执行细节,通常也不需文档化

中文场景下的实操建议

别为了“用新语法”而牺牲文档可用性。真实团队协作中更稳妥的做法是:

  • 继续用 /** @bodyParam ... */ 写参数说明,确保 Scribe 能提取;属性只用于运行时逻辑控制
  • 若已大量使用 PHP 属性做验证,可保留 FormRequest 类,它天然兼容 Scribe,无需额外注释
  • 避免混用:不要在一个方法上既写 #[Validate] 又写 @bodyParam,容易造成语义重复或冲突
  • 中文文档显示正常,只需在 config/scribe.php 中确认 'language' => 'zh' 并启用中文字体支持(如 Noto Sans SC)

工具没跟上语言演进很正常。现阶段,注释不是过时,而是文档生成的事实标准;属性是运行时增强,二者分工明确,不必强行统一。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

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

热门AI工具

更多
豆包大模型

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

立刻MV
立刻MV Hot

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

WorkBuddy

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

DeepSeek

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Loomy
Loomy Hot

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

相关专题

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

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

12684

2023.09.01

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

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

7281

2023.10.11

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

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

2255

2023.10.11

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

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

4588

2023.10.23

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

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

5314

2023.10.23

html怎么上传
html怎么上传

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

4171

2023.11.03

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

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

6057

2023.11.09

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

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

4762

2023.11.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

120

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 225人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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