Laravel-ide-helper 能幫助你的五個方面

一、優化代碼補全

Laravel-ide-helper可以更完美的支持Laravel框架自帶的代碼補全。

安裝laravel-ide-helper:

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

然後在config/app.php中加入：

'providers' => [
    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
]

最後執行：

php artisan ide-helper:generate

該命令會為你的Laravel應用生成一個叫做_ide_helper.php的文件，該文件包含Laravel中包含的所有類的完整數據列表，以及提供類型提示可以使用的注釋。

二、優化Eloquent模型的屬性和方法注釋

Laravel-ide-helper不僅可以增強代碼補全，還可以為Eloquent模型添加屬性和方法注釋。假設我們有這樣一個Eloquent模型：

App\User.php

class User extends Model
{
    //
}

執行如下命令即可：

php artisan ide-helper:models -W

Laravel-ide-helper還可以為Eloquent模型自動生成屬性和方法的注釋。

/**
 * App\User
 *
 * @property int $id
 * @property string $name
 * @property string $email
 * @property string|null $email_verified_at
 * @property string $password
 * @property string|null $remember_token
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder|User newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|User newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|User query()
 * @method static \Illuminate\Database\Eloquent\Builder|User whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereEmailVerifiedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User wherePassword($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereRememberToken($value)
 * @method static \Illuminate\Database\Eloquent\Builder|User whereUpdatedAt($value)
 * @mixin \Eloquent
 */
class User extends Model
{
    //
}

三、優化輔助函數的注釋

Laravel框架自帶的全局輔助函數，如view()，csrf_token()等，在IDE中有可能會出現不能正確提示的情況，使用laravel-ide-helper工具包進行優化，即可實現自動提示。

php artisan ide-helper:generate -H

註：laravel-ide-helper更新後，需要加-H參數，否則看不到全局輔助函數

四、優化控制器方法注釋

Laravel-ide-helper工具包還可以實現Controller中類的方法參數提示

php artisan ide-helper:generate -M

註：laravel-ide-helper更新後，需要加-M參數，否則看不到控制器方法參數的注釋。

五、優化路由文件注釋

Laravel-ide-helper還可以為路由文件注釋,最後生成的方法注釋如下：

/**
 * Class UserController
 *
 * @package App\Http\Controllers
 * @param int $id Example: The ID of the user.
 * @param string|null $name
 * @return Response
 */
public function showProfile(int $id, string $name = null)
{
    //
}

生成路由文件注釋的命令如下：

php artisan ide-helper:generate -R

總結

Laravel IDE Helper是一種為Laravel項目生成代碼提示的優秀工具，同時也可以為你節約下大量的開發時間。