Packageist 地址:https://packagist.org/packages/barryvdh/laravel-ide-helper
安装:

  1. composer require barryvdh/laravel-ide-helper --dev

另外需要安装依赖,模型注释字段要用到

  1. composer require doctrine/dbal --dev

在「config/app.php」的「providers」数组中加入(Laravel 5.5 后会自动加入。)

  1. Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class

导出配置文件

  1. php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config

为 Facades 生成 phpDocs 注释

  1. php artisan ide-helper:generate

为 Models 生成 phpDocs 注释

  1. php artisan ide-helper:models

紧接着会提示,是否在模型文件中写入注释。这里选择 no ,不注释。

为 PhpStorm 生成类路径提示文件

  1. php artisan ide-helper:meta

自动运行 generate

在依赖包更新更新时自动更新注释,可以在 composer.json 文件中做如下配置:

  1. "scripts":{
  2. "post-update-cmd": [
  3. "Illuminate\\Foundation\\ComposerScripts::postUpdate",
  4. "php artisan ide-helper:generate",
  5. "php artisan ide-helper:meta"
  6. ]
  7. }

注意,这样可能会报错。所以不要轻易配置。