karakaram-blog

PhpStormのSymfony開発を加速するPHP Annotationsプラグイン

 ツイート 8  シェア 0  Google+1 0  Hatena 5

PhpStorm PHP Annotations Plugin 補完1

この記事は Symfony Advent Calendar 2015 の 3 日目の記事です。

PhpStorm での Symfony 開発プラグインといえば Symfony2 Plugin が有名ですね。このブログでも過去に PhpStormのSymfony2 Pluginによる入力補完が便利すぎる という記事で紹介しました。

今回は PHP Annotations というプラグインを紹介します。このプラグインはアノテーションの入力補完をサポートするプラグインで、Symfony2 plugin のかゆいところをフォローします。Symfony2 plugin に依存してるのでセットで入れておくのがオススメです。導入されていない方はぜひお試しください。

動作確認環境

  • Mac OS X El Capitan
  • PhpStorm10

目次

  1. Entity のアノテーションの入力補完が効くようになる
  2. アノテーションの use 文の警告が消える
  3. インストール

Entity のアノテーションの入力補完が効くようになる

PHP Annotations プラグインを入れると Entity のアノテーションの入力補完が効くようになります。Entity のアノテーションは長くて覚えづらいので、補完が効くとすごく楽になります。

PhpStorm PHP Annotations Plugin 補完1

PhpStorm PHP Annotations plugin 補完2

他にも補完が有効になるアノテーションがあります。詳しくはドキュメントをご確認ください。
Haehnchen/idea-php-annotation-plugin – GitHub

アノテーションの use 文の警告が消える

コントローラのアノテーションに @Route@Method, @Template などを書くと、コードの上のほうにある use 文で Warning が出ます。

PhpStorm Annotation の警告

上記の例は Template クラスがどこにも使われてないよ、という警告です。このままでも PHP 的には全く問題ありませんが、PhpStorm の警告はできるだけ無くしてクリーンな状態を保ったほうが安心して前に進めるので、この警告はでないようにしたいです。

PHP Annotations を入れると、この警告が消えます。スッキリ。

アノテーションの警告が消えた

インストール

設定ウィンドウの Plugins から「php annotation」と検索してインストールします。

PHP Annotations plugin インストール

  • 設定ウィンドウ > Plugins をクリック
  • Browse repositories ボタンをクリック
  • 検索ウィンドウに「php annotation」と入力
  • プラグイン一覧から PHP Annotations をダブルクリックしてインストール
  • 変更を Apply して再起動

PHP Annotations は Symfony2 plugin に依存しているので、Symfony2 plugin も一緒に入れておいてください。

 ツイート 8  シェア 0  Google+1 0  Hatena 5