使用 PHPDoc 提示 Laravel 的魔術方法

前言

Laravel 使用了許多的魔術方法，為了讓編輯器能有更友善的提示，因此可以使用 PHPDoc 註解，避免出現錯誤提示。

範例

使用 @property 標籤，告訴編輯器 User 模型有一個 $name 屬性。

/**
 * @property string $name
 */
class User extends Authenticatable
{
    // ...
}

使用 @var 標籤，告訴編輯器 $user 變數實際上是一個 User 模型。在存取 $user 變數時，就不會出現錯誤提示。

/** @var User $user */
$user = factory(User::class)->create();

$user->name; // 魔術方法