laravel使用手札——使用PHPStorm提升开发速度

最新推荐文章于 2025-09-05 14:41:09 发布

转载最新推荐文章于 2025-09-05 14:41:09 发布 · 97 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://segmentfault.com/a/1190000004980370

文章标签：

#开发工具 #json #php

本文详细介绍如何在PHPStorm中安装并配置laravel-ide-helper以实现代码自动提示功能，同时介绍如何通过安装PHPAnnotationsPlugin和Symfony2Plugin来支持Swagger API文档的生成。

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才能很好地使用备注补全功能。