今回はPHPに絞ったVisual Studio Codeのおすすめ設定、拡張機能を紹介していこうと思います。
人気のインテリセンス機能のPHP IntellisenseとPHP Intelephenseは比較しながら見れるように、どちらも紹介しますので、好みの方を見つけてみてください。
共通で入れておきたい設定や拡張機能は以下で紹介しております。
最近人気のエディタといえば、Atom、Sublime Text、Visual Studio Codeあたりでしょうか。 今までAtomを使用してましたが、Visual Studio Codeに乗[…]
基本設定
PHP Suggest : Basic
Visual Studio Codeがデフォルトで持っているPHPのコード補完機能です。
ここにチェックを入れるとコード補完してくれるようになります。
使う場合は基本設定の上部の検索画面に「phpsuggestbasic」と入力してチェックを入れておきましょう。
変更後：
PHPに関するキーワードが補完されるようになりました。
PHP Validate: Enable
Visual Studio Codeがデフォルトで持っているPHPのコード補完機能です。
ここにチェックを入れると文法チェックしてくれるようになります。
使う場合は基本設定の上部の検索画面に「phpvalidateenable」と入力してチェックを入れておきましょう。
変更後：
エラー箇所を赤い波線で表示してくれます。そこをマウスオーバーすると、詳細が表示されます。
次からはVisual Studio CodeのPHPに関する便利な拡張機能を紹介していきたいと思います。
拡張機能
PHPに関する拡張機能でおすすめのものを紹介していきたいと思います。ここで紹介するのは、PHP IntellisenseとPHP Intelephenseですが、どちらもインテリセンス機能のものですので、どちらか好みの方を入れておくといいと思います。
PHP IntelliSense
PHP IntellisenseはPHPのコード補完やらコードチェックをしてくれるもので、次に紹介するPHP Intelephenseとどちらか好みの方を入れておくといいと思います。
https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense
ちなみにこれを使用するにはPHPをインストールして、パスに追加しておくか、基本設定のphp.exectablePathを設定する必要があります。
上記のページにもありますが、機能を1つずつ紹介していきます。
コード補完
先のPHP Suggest Basic 同様にキーワード候補を出してくれます。
文法の誤りのチェック
先のPHP Validate Enable 同様にエラーチェックをしてくれます。
マウスオーバーで詳細の表示
変数やクラス名などをマウスオーバーするとその定義を見ることをできます。
メソッド引数
引数を選択する際に条件を提示してくれます。
定義に移動
変数やクラス名などを左クリックし、定義へ移動を選択すると定義箇所に移動することができます。
全参照を検索
同じく左クリックして参照へ移動をクリックすると参照箇所を検索できます。
プロジェクト内検索
macなら「⌘+p」、windowsなら「ctrl+p」でクイックオープンを開きます。そこに「#+検索ワード」を入力すると、プロジェクト全体から作成した変数やメソッド、クラスを検索することができます。
検索されるのは定義されているもののみです。
グレーのスパナみたいなマークが変数、オレンジのマークがクラス、紫の箱みたいなマークがメソッドとなっています。
ファイル内検索
macなら「⌘+p」、windowsなら「ctrl+p」でクイックオープンを開きます。そこに「@+検索ワード」を入力すると、同ファイル内から変数やクラス名などを検索できます。
Visual Studio Code では「⌘+f」(「ctrl+f」)で検索ができますが、こちらは定義の部分だけを探してくれます。
Visual Studio Codeではデフォルトでコード補完機能、エラーチェック機能がありますが、こちらのほうが頭がいいと思われます。
こちらをインストールする場合は基本設定のデフォルトの補完機能（PHP Suggest : Basic, PHP Validate: Enable）はオフにしておくことを推奨します。
PHPにはもう一つインテリセンス機能のある拡張機能があります。
PHP Intelephense
PHP IntelephenseもPHP Intellisenseと同じくコード補完やらコードチェックをしてくれるもので、好みの方を入れておくといいと思います。
https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client
こちらは拡張機能を導入するだけで、他に特に何もしなくても利用が可能です。
操作感などはPHP Intellisenseと変わりません。
未使用変数のグレーアウト
こちらはPHP Intellisenseにはない機能のようでして、未使用変数がわかりやすく色が薄くなります。
コード補完
PHP Suggest BasicやPHP Intellisense 同様にキーワード候補を出してくれます。
PHP Intellisense より詳しい説明が見れます。
文法の誤りチェック
PHP Validate Enable やPHP Intellisense 同様にエラーチェックをしてくれます。
マウスオーバーで詳細の表示
変数やクラス名などをマウスオーバーするとその定義を見ることをできます。
メソッド引数
引数を選択する際に条件を提示してくれます。
定義に移動
変数やクラス名などを左クリックし、定義へ移動を選択すると定義箇所に移動することができます。
全参照を検索
同じく左クリックして参照へ移動をクリックすると参照箇所を検索できます。
プロジェクト内検索
macなら「⌘+p」、windowsなら「ctrl+p」でクイックオープンを開きます。そこに「#+検索ワード」を入力すると、プロジェクト全体から作成した変数やメソッド、クラスを検索することができます。
検索されるのは定義されているもののみです。
一致条件が違うみたいで、PHP Intellisense よりも多くの結果が表示されています。
ファイル内検索
macなら「⌘+p」、windowsなら「ctrl+p」でクイックオープンを開きます。そこに「@+検索ワード」を入力すると、同ファイル内から変数やクラス名などを検索できます。
こちらをインストールする場合は基本設定のデフォルトの補完機能（PHP Suggest : Basic, PHP Validate: Enable）はオフにしておくことを推奨します。
PHP Intellisense と PHP Intelephense どっちがいい?
PHP Intellisense と PHP Intelephense の両方を使用してみた感想としては、他の方も書かれている通りPHP Intelephenseを使うのがいいと思います。
PHP Intellisense のほうが読み込みに時間がかかる印象があり、しばしば「読み込み中です」というエラーが出てしまいます。
さらに、上で見ていただいたとおり、PHP Intelephenseの方が検索の質や表示してくれる情報の質が良いと思います。
あと、PHP Intelephenseのみの機能と思われる、未使用変数のグレーアウトがメソッドを書き換えたときなんかになかなか役に立ちます。
HTMLの拡張機能も入れておくと便利
最後に、PHPではよくHTMLやCSSも一緒に記述することになると思います。
ですので、HTMLやCSSの拡張機能を入れておくことで、更に快適にコーディングを行えるようになります。
以下別ページでHTMLやCSSの設定について解説しておりますので、もしよかったらこちらも見てみてください。
私はPHPやJavaScriptを書くことが多いですが、これらの言語と合わせて使用されるものにHTMLとCSSがありますね。 今回はHTML, CSSを書くときに便利なVisual Studio Codeの拡張機能[…]
最後に
ここまで、PHPを書くためのVisal Studio Codeのおすすめ設定を紹介してきました。
PHP開発する場合は基本的にインテリセンス機能があれば十分かなと思います。
HTMLを記述するのが多い方は、HTMLに関する拡張機能も入れておけばより快適になるかと思います。