PHP 8环境下如何使用新属性替换PHPDoc 适配Laravel开发需求

PHP 8 属性改写方案 #

你提供的Laravel资源类方法可以按以下方式改写，完全替代原有PHPDoc的功能：

1. 基础类型标注替代（最常用场景）

PHPDoc里的参数、返回值类型声明可以直接用PHP 8原生的类型提示实现，这也是官方推荐的替代方案，IDE和静态分析工具都原生支持，比PHPDoc准确性更高：

public function toArray(\Illuminate\Http\Request $request): array
{
    //Some code
    return [];
}

2. 完整元数据替代（如需保留方法说明等注解信息）

如果原来的PHPDoc里的方法描述等信息需要作为可被程序读取的元数据（比如用于自动生成API文档、权限校验等场景），可以配合PHP 8的Attribute属性实现：
首先自定义对应的属性类（框架自带对应属性的话可直接使用，无需自定义）：

#[Attribute(Attribute::TARGET_METHOD)]
class ApiMethod
{
    public function __construct(
        public string $description,
    ) {}
}

改写后的业务代码如下：

#[ApiMethod(description: 'Transform the resource into an array.')]
public function toArray(\Illuminate\Http\Request $request): array
{
    //Some code
    return [];
}

说明

• 普通开发场景下用第一种写法就足够，原生类型声明已经覆盖了原PHPDoc中@param、@return的全部功能，运行时还会自动做类型校验，避免隐式类型转换导致的bug。
• 如果需要用到注解能力（比如和框架的注解路由、自动文档生成工具配合），再用第二种Attribute的写法，属性里的元数据可以通过反射在运行时读取，比解析PHPDoc字符串性能更高、可靠性更强。

内容的提问来源于stack exchange，提问作者Kasun Sampath Weligamage