📝

【VSCode】スニペットで開発効率向上!

2 min read

コードスニペットとは

コードスニペットは、右クリック メニュー (コンテキスト メニュー) コマンドまたはホット キーの組み合わせを使用してコード ファイルに挿入できる、再利用可能なコードの小さなブロックです。
https://docs.microsoft.com/ja-jp/visualstudio/ide/code-snippets?view=vs-2019

コードのかたまりを登録しておけば、後で簡単に入力出来る便利な機能です

言葉を知らなくても既に使っている方が多いかもしれません
for文を書く時
"for"とだけ入力しtabキーを押すことで
for文の型を一気に入力したことはありませんか?

for ( size_t i = 0; i < length; i++ )
{

}

それがコードスニペットの機能です
forデフォルトで登録されているものになります

コードスニペットを使用すれば入力に1分かかっていたものが、1秒で書くことが出来ます
よく使うコードを登録してQOLを向上させましょう!

php.jsonを開く

VsCodeでコードスニペットを使用するには
php.jsonにコードを追加する必要があります

  1. ctrl + shift + Pで "sni" と入力

  2. ユーザースニペットの構成を選択

  3. php.jsonを選択

  4. php.jsonが開けた!

コードスニペットの追加

php.jsonの下の方に追加してください

php.json
"var_dump": {                // コードスニペット名
    "prefix": "var",         // トリガーワード
    "body":[                 // 自動入力されるコード
        "echo '<pre>';",
        "var_dump($1);",
        "echo '</pre>';"
    ],
    "description": "変数内容出力"    // 概要
},

コードスニペット名

タイトルみたいなものです
この場所以外には表示されないので、自分が分かりやすい名前を付けてください

トリガーワード(prefix)

自動入力されるきっかけのコードを書いてください

自動入力されるコード(body)

よく使用するコードを書いてください

$1というのはカーソル位置になります
$1 : 自動入力後のカーソル位置
$2 : 自動入力後のカーソル位置2つ目
$0 : 最後のカーソル位置
基本的に$1のみ覚えていれば十分です

概要(description)

コメントみたいなものです
省略も可能です


追加するとこんな感じになると思います

コードスニペットの使い方

トリガーワードを入力してtabキーを押すことで使えます
例でいうと"var"まで入力してtabキーを押すとコードが入力されます


カーソル位置もしっかり()の中に入っています

終わりに

こんな感じで、またこのコード書いてる...って思ったらコードスニペットを思い出してください
これで開発速度爆上げQOL向上