VSCode の IntelliSense を利用しよう

VSCodeの入力サポート機能の紹介

 Python向けレトロゲームエンジン「Pyxel(ピクセル)」の解説書『ゲームで学ぶPython! Pyxelではじめるレトロゲームプログラミング』で,初めてVSCodeを使用する人向けの記事です。
 VSCodeでコードを入力すると入力候補が何度も出てくると思いますが,この入力候補(コード補完)(※1)を表示しているのがIntelliSenseで,IntelliSenseの機能のごく一部(※2)でも利用すると入力スピードが上がるので使ってみましょう。

 ※1 入力候補の部分の語句としては「suggestion 提案」が適切ですが,日本語入力時の変換候補の見た目に近いので「候補」という言葉を本記事では用います。

 ※2 「候補の先頭になったら Tabキー を押すと入力できる」これだけでも覚えておきましょう。
 

IntelliSense(インテリセンス)

 公式ユーザーガイド https://code.visualstudio.com/docs/editor/intellisense
 入力方法の説明や,各アイコンの意味などが載っています。
 

一番上の候補で確定する操作

(1) imと入力した時点で,候補の先頭に入力したい import が表示された。

(2) 「Tab」キーまたは「Enter」キーを押すと import が入力できる。

 ※(1)の候補表示状態で「Esc」キーを押すと im だけで入力終了。 スペースキーで区切って次入力も可

リスト中の候補を入力する操作

(1) pと入力したリストの print を入力したいとき。

(2) 下方向キーを押してフォーカス(選択状態)を移動させてから「Tab」キーまたは「Enter」キーを押す。

 ※マウスでも選択できますが,慣れるとキーボード入力の方が便利です。
 ※ (1)から p に続けてrt などの文字を入力して候補 print に絞ることもできます。
  5章に出てくるような変数 ○○○○_x,○○○○_vx,○○○○_y,○○○○_vy の絞り込みに vy を追加で入力するなどしてみてください。(次の項で解説)

候補の絞り込み例

(1) 下記で入力したいものが player_vy のとき

(2) 続けて vy を入力すると絞り込める

 先頭に来たのでTabキーで確定させる

変数や関数が長い名前でも全部覚えなくてよい

下記は長い名前の変数を使っているケースで,途中の文字を入力した状態でリストに表示される例です。(player_longlongname)

 

入力済みの文字に続く入力候補を強制表示

(pyxel.までの入力で確定してしまったが,もう一度続きの候補でinitを表示したいときの例)
(1) 入力済みのコードに続く候補を表示させたいときは「Ctrl + Space」キーを押す。

(2) 候補が表示される

(3) i を入力して絞り込み。上下方向キーで移動,「Tab」キーまたは「Enter」キーで入力できる。

クイック情報の展開

入力候補表示時に「Ctrl + Space」を押すと,メソッドのクイック情報を横に展開できる。

 ※ もう一度「Ctrl + Space」を押すと表示が消える。右上×ボタンで消してもよい
 

日本語入力時の変換候補との違いに注意

 WindowsIMEなど日本語入力時の変換候補の選択は,Tabキーで次々候補を移動できますが,IntelliSenseでTabキーを押すと確定なので注意してください。

IMEではTabキーで次の候補に移動できる

問題内容の表示

 本記事の画像で,タブのファイル名がオレンジ色に変化しているのは,そのファイルのコードに問題があることを示しています。波線の場所にマウスカーソルを持っていくか,「Ctrl+Shift+M」キーを押すと問題内容を表示できます。

ファイル名の後ろの数字が問題の数

「Ctrl+Shift+M」キーで表示