laravel使用手札——使用PHPStorm提升開發(fā)速度

caozhijian 發(fā)布于2019-07-01 12:14 / 2509人閱讀

摘要：安裝支持和請移步到使用手札。在安裝支持菜單欄搜索和安裝使用時(shí)可不用完全參照插件的備注方式，使用自動(dòng)補(bǔ)全內(nèi)容的格式便可以，即建設(shè)的備注格式在自動(dòng)補(bǔ)全小結(jié)從官方文檔能看出對于支持可選和，經(jīng)過試驗(yàn)后發(fā)覺必須安裝才能很好地使用備注補(bǔ)全功能。

PHPStorm安裝

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

代碼自動(dòng)提示支持

laravel引入laravel-ide-helper能為PHPStorm提供相應(yīng)支持

composer require barryvdh/laravel-ide-helper

添加以下代碼到config/app.php的providers里

BarryvdhLaravelIdeHelperIdeHelperServiceProvider::class,

構(gòu)建相關(guān)內(nèi)容：

php artisan ide-helper:generate

再把構(gòu)建添加到composer.json配置

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

完成上面步驟即可于PHPStorm內(nèi)快樂地使用代碼自動(dòng)提示了，其余配置請看laravel-ide-helper

使用Swagger提供API文檔

使用Swagger能很好地提供一套文檔自動(dòng)生成方案，并有效解決前后臺(tái)工作交付等溝通上的問題。

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

在PHPStorm安裝支持

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

搜索 PHP Annotations Plugin 和 Symfony2 Plugin 安裝

使用時(shí)可不用完全參照laravel插件zircote/swagger-php的備注方式，使用PHPStorm自動(dòng)補(bǔ)全內(nèi)容的格式便可以，即：

##Swagger-php建設(shè)的備注格式
/**
 * @SWGInfo(title="My First API", version="0.1")
 */

/**
 * @SWGGet(
 *     path="/api/resource.json",
 *     @SWGResponse(response="200", description="An example resource")
 * )
 */
 
##在PHPStorm自動(dòng)補(bǔ)全
/**
 * @Info(title="My First API", version="0.1")
 */

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

Swagger小結(jié)

從Swagger官方文檔能看出對于PHPStorm支持可選PHP Annotations Plugin和Symfony2 Plugin，經(jīng)過試驗(yàn)后發(fā)覺必須安裝PHP Annotations Plugin才能很好地使用備注補(bǔ)全功能。