モダンなIDE PhpStormのPHPエディタ機能

いまさら、ニンテンドーDSのレイトン教授シリーズを1作目からプレイしているtanakaです。今日は、もう半年弱つかってるIDE PhpStormのPHPエディタのお気に入りポイントを紹介します。コードの不備を指摘してくれるので、使っていて安心できますよ

お気に入りその1 ローカル変数が使われているかチェックしてくれる

代入した変数が使われているかチェックしてくれる機能…っていうと、他のIDEでもあるかもしれません。上の画像を見てください。$val1 は後で使われているので、警告されません。$val2は使われていないので、警告が出ます。最後が渡しのお気に入りのポイントで、$val3に注目してください。直接ソースコードで参照してはいませんが、compact関数で利用されていることがきちんとチェックできています。CakePHPフレームワークで、コントローラからビューにデータを渡すときに、このcompact関数(=変数を、変数名をキーにした連想配列にまとめる)が便利なので多用するんですが、そこまでチェックしてくれるのでとても楽です

お気に入りその2 PhpDoc作成のアシストがすごい

関数/メソッド/クラスの直前に、その中身のコードがなにをしているのかを、規定された形式で書かれたコメントがPhpDocです。ですが、なにかとコードに変更を加えている中でコメントとの整合性がとれなくなりがちです。PhpStormのエディタは、この不整合を細かくチェックしてくれることで、ドキュメントも修正しなきゃ！というやる気を起こしてくれます。次の画像を見てください。

PhpDocのコメント部分と、メソッド内のreturn文で警告の下線が表示されてます。これが、PhpDocの不整合を検出している印です。

上のコメントにマウスを合わせると、「PhpDocのコメントが、メソッドのシグニチャ(引数などメソッドのインターフェイスのこと)と合ってないよ」と指摘されます

return文に合わせると、「コメントじゃ戻り値がないことになってるのに、実際は戻り値があるよ」と言われます。メソッドの仕様が変わる、ということに気づかせてくれる機能でもありますね。

まとめ

PhpStorm のエディタの、ミスを防ぐための機能を紹介しました。