【PhpStorm】コードスニペットを登録する

PhpStormでコードスニペットを登録する手順について。

WebStormも同様のはずです。(PHPの場合の注意点あり)

コードスニペットを登録する手順

メニューの「File > Settings…」をクリックか、ショートカットのCtrl+Alt+S(MacならCommand+,)で設定ウインドウを開きます。

phpstorm-code-snippet01

 

設定ウインドウの左サイドメニューから「Live Templates」をクリックして選び、コードスニペットを登録したい言語をクリックします。今回僕はPHP用のコードスニペットを登録したいのでPHPを選択しています。

phpstorm-code-snippet02

 

その後、右上に見える「+」ボタンをクリックします。(Live Templatesは下の方にあります)

「+」ボタンをクリックすると

  • Live Template
  • Template Group…

と2つあるので「Live Template」を選択します。

「Template Group…」は新たにコードスニペットのグループを作成出来ます。既にある「html/xml」や「Javascript」、「PHP」のようなグループですね。

phpstorm-code-snippet03_

 

Live Templateをクリックすると、ウインドウ下にコードスニペットの登録エリアが現れます。

Abbreviation」の項目にはスニペットを変換する略字を入力し、その下にある「Template text:」に対応するコードを記述します。

右側にあるOptionの「Expand with」は略字を変換するキー設定です。初期値ではTabになっているので、変えたい場合は選択肢からキーを選びます。

Descriptionは説明なので必要だと思う場合に入力しましょう。

phpstorm-code-snippet04

 

最後に、一番下に「No applicable contexts yet. Define」とあるのでDefineの文字をクリックしてスニペットを有効化したい言語にチェックを入れ、右下の「Apply」で適用保存してOKボタンを押します。

このチェックを入れないとスニペットは使えません
このチェックを入れないとスニペットは使えません

これでコードスニペットの登録は完了です。

上記の画像の例で説明しますが、このスニペットを使う場合は「dump」と入力した後、カーソルが文字の最後尾に来ている状態でTabを押すことで変換されます。

 PHPのスニペットを登録する場合の注意点

適用する言語を「PHP」にした場合、これはつまりPHPの開始タグ~終了タグの間でのみコードスニペットが有効になります。

例えば以下のようなスニペット(略字:hdump)を登録したい時は、適用する言語を「HTML」にしなければ動きませんでした。

というのも、PHPの開始、終了タグの中でならもちろん変換されるのですが、その外側では変換が出来ませんでした。

どうやらコードスニペットの有効範囲を「PHP」に設定した場合、これはphpタグの中を意味しているようです。ファイル形式で判断しているワケではないようなので注意しておく必要があります。

最終更新日:2014年9月28日

コメント

「何かそこ違うよ」「こうした方が良い」っていう部分があったら指摘して頂けると嬉しいです。

トラックバック

トラックバックは現在ありません。

Trackback: https://increment-log.com/phpstorm-code-snippet/trackback/