Visual Studio Codeのユーザースニペットを使いこなそう

こんにちは、アプリコットのこばです。
まだまだ残暑が厳しい9月後半です。日焼けが止まりません。

今日はVisual Studio Code（以下、VSコード）のお話です。
皆さん、VSコードの「ユーザースニペット機能」は活用してますか？

ユーザースニペット機能とは

ユーザースニペット機能とは、よく使う長文のコードを予め登録しておくことで、短いコードで簡単に呼び出すことのできる機能です。
パソコンやスマホのユーザー辞書と一緒ですね。

例

$args = array(
 "post_type" => "hogehoge",
 "posts_per_page" => 3,
);
if(have_posts()):
while(have_posts()): the_post();
endwhile;
//投稿がある場合の処理
else:
//投稿がない場合の処理
endif;

毎回必ずといっていいほど使うソースってありますよね。ある程度フォーマットのままのものであればプラグインなどで補うことも可能ですが、自分がコーディングしやすいようにカスタムする場合は、この機能が便利です。

ユーザースニペットの登録方法

①VSコードを開き、左下の歯車→ユーザースニペットの順にクリック

②スニペットファイルの選択で登録したい言語を選択

注）
・phpの場合はhtml.jsonに登録しましょう！
・プルダウンに出てこない場合は入力ボックスに言語を入力し、「言語名.json」を選択します

③スニペットの登録

実際にスニペットを登録していきます。

スニペット名：Print to Consoleの部分。自分が分かればなんでもOK
プリフィックス名：logの部分。呼び出すときのショートカット名です。
ソース：吐き出すソースコードをbodyの中に記述します。コロンで改行します。$1,$2はスニペットを呼び出したときに自動でカーソルがその場所まで移動します。他にも””を使う場合は”、タブを入れる場合はtを使います。
説明文：descriptionはこのスニペットの説明を入れます。こちらは任意。

④実際に吐き出す

実際にソースを吐き出してみます。

スニペットの中に先程作ったものが出てくるのでクリックします。

はい、ラクチンです。

そのほかにも、slickのよく使うオプションをまとめて登録しておいたりしています。
あまり作りすぎると、それはそれで覚えるのが大変ではありますが、うまく使ってコーディング速度を上げたいですね。

余談ですが冒頭紹介したユーザー辞書もめちゃめちゃ便利です。
また改めて紹介しようと思います。

それでは！