PhpStormでヒアドキュメント内の言語のハイライトと入力補完

PhpStorm には、ヒアドキュメントにシンタックスカラーを適用したり、ヒアドキュメント内で入力補完できる機能があります。

ヒアドキュメントを使用するとソースコードが読みづらくなりがちなので好きではありませんが、案件によっては多用していたりするのでこの tips が有効な現場も多いと思います。

動作確認環境

以下は普通にヒアドキュメントで HTML を書いているところです。ヒアドキュメントの ID は EOT にしています。PhpStorm では文字列として判定されているようで、緑色になっていますね。

ヒアドキュメントの ID を HTML にすると、ハイライトと入力補完が有効になります。Emmet(ZenCoding) も使えます。

CSS の場合は ID を CSS にします。

JS の場合も、ID を JS にすれば OK です。

SQL 文のハイライトと入力補完もできます。

以下は DB のマイグレーション用に CREATE 文をヒアドキュメントで書いているところです。ヒアドキュメントの ID を SQL にすると、キーワードがハイライトされます。

ハイライト表示されましたが、何か見づらいですね。PhpStorm が何やらアラートを発しているようです。SQL Dialect を設定して、アラートを解除します。

Preferences　＞　Project Settings　＞　SQL Dialects

アラートが消え、見やすくなりました。見やすくなったら SQL の構文エラーも見つかりました。カンマが多いです。こういったエラーもチェックしてくれます。

入力補完も有効です。

PhpStorm からデータベースに接続するように設定すると、テーブル名やカラム名の補完を行ってくれるようになります。設定方法は SQLが書きやすい！PhpStormからMySQLに接続する方法にまとめてあります。

: SQLが書きやすい！PhpStormからMySQLに接続する方法

この記事では、PhpStorm からMySQLに接続する方法を紹介します。 PhpStormはデータベースクライアントと ...

続きを見る

いかがでしたか。ヒアドキュメントを多用しているプロジェクトでは、この tips は有用と思います。機会があればお試しください。