PhpStormにPSR-2を適用する
PSR-2とは?
まず"PSR-2″とは端的に言ってしまうとコーディングルールのことです。
下記のようなルールがあります。
- インデントには4つのスペースを使用し、タブは使用してはいけません。
- 行の長さに対してハードリミットがあってはいけません。ソフトリミットは120文字を上限とし、実際は80文字以内に抑えるべきです。
- 名前空間定義のあとには空行を挟まなければいけません。またuse定義ブロックのあとにも同様に空行を挟まなければなりません。
- クラスの開き括弧は次の行に記述しなければなりません。また閉じ括弧は本文最後の次の行に記述しなければなりません。
他にも様々なルールがあります。
参照:http://www.infiniteloop.co.jp/docs/psr/psr-2-coding-style-guide.html
PSR-2を適用しなくても開発に問題はありませんが、適用することにより可読性、メンテナンス性が大きく向上します。
リファクタリングやコードレビューのしやすさが段違いですね。
最初は覚えるのが大変かもしれませんが、慣れてしまえば結構簡単です。
個人的な感想としては開発にLaravel等のフレームワークを使用する際に威力を発揮します。
設定方法
まずは下記を参考にデフォルトのコードスタイルをPSR-2に設定。
※参照記事自体は2014年のものですが、2019/10/15現在でも設定方法に変わりありません。
リフォーマットも設定
そのあと、既存のコードにもPSR-2を適用するため、リフォーマットを行います。
PhpStormは下記のコマンドでリフォーマットできます。
Mac:Option + Cmd + L
Windows:Alt + Ctrl + L
私はデフォルトのショートカットのままリフォーマットを活用していますが、好みによってショートカットを変更することも可能です。
ショートカットの設定
現在はPSR-12も登場している
2019/11/30現在、PSR-2を拡張・継承したPSR-12も登場しています。
PSR-12についての説明は下記の記事で説明しています。
まとめ:PSR-2の効果は大きい
設定は少し面倒ですが、それ以上の効果を実感できますよ。