phpdoc - 如何用 php 8 中的新属性替换 phpdocs

Question

我正在使用 laravel。我需要知道如何使用属性在 php 8 中编写 phpdoc。

/**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
      //Some code
      return [];
    }

谁能解释一下上面的代码是如何用属性编写的。

Answer 1

我相信您误解了属性的用途，以及它们与文档 block 的关系。文档 block (用/** ... */标记的注释)有两种常见的用法:

• 以最标准化的方式记录代码(因此得名“文档 block ”)，可以被各种工具读取，包括文档生成器和 IDE。
• 向代码添加机器可读的注释，以便与可以根据这些自动生成行为的库和框架一起使用。例如，ORM 可能使用 @TableName('Foo') 的注释将类链接到特定的数据库表，并生成适当的 SQL。

您展示的示例是第一次 用法。你所写的仍然是编写文档的正确方法。

PHP 8 的原生属性取代了第二种用法。查找什么属性取决于库，但是以前在文档 block 中查找 @TableName('Foo') 的 ORM 现在可能会查找 #[TableName('Foo') ] 作为 native 属性。