laravel使用手札——使用PHPStorm提高開發速度

PHPStorm安裝

PHPStorm 使用手札——安裝看這裏

代碼自動提示支持

laravel引入laravel-ide-helper能爲PHPStorm提供相應支持

composer require barryvdh/laravel-ide-helper

添加如下代碼到config/app.php的providers裏

Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,

構建相關內容：

php artisan ide-helper:generate

再把構建添加到composer.json配置

"scripts":{
    "post-update-cmd": [
        "php artisan clear-compiled",
        "php artisan ide-helper:generate",
        "php artisan optimize"
    ]
},

完成上面步驟便可於PHPStorm內快樂地使用代碼自動提示了，其他配置請看laravel-ide-helper

使用Swagger提供API文檔

使用Swagger能很好地提供一套文檔自動生成方案，並有效解決先後臺工做交付等溝通上的問題。

Laravel安裝Swagger支持和Swagger-ui請移步到laravel使用手札——Swagger。

在PHPStorm安裝支持

菜單欄
File -> Setting -> Plugins -> Browse repositories

搜索 PHP Annotations Plugin 和 Symfony2 Plugin 安裝

使用時可不用徹底參照laravel插件zircote/swagger-php的備註方式，使用PHPStorm自動補全內容的格式即可以，即：

##Swagger-php建設的備註格式
/**
 * @SWG\Info(title="My First API", version="0.1")
 */

/**
 * @SWG\Get(
 *     path="/api/resource.json",
 *     @SWG\Response(response="200", description="An example resource")
 * )
 */
 
##在PHPStorm自動補全
/**
 * @Info(title="My First API", version="0.1")
 */

/**
 * @Get(
 *     path="/api/resource.json",
 *     @SWG\Response(response="200", description="An example resource")
 * )
 */

Swagger小結

從Swagger官方文檔能看出對於PHPStorm支持可選PHP Annotations Plugin和Symfony2 Plugin，通過試驗後發覺必須安裝PHP Annotations Plugin才能很好地使用備註補全功能。