知っておきたいVSCodeの使い方とデバッグ方法

2024年6月6日2024年7月13日

本ブログでは VSCode（Visual Studio Code）をPython開発ツールとして採用しています。本ブログで公開する自作ツールの動作を確認したり、機能追加や修正を行う場合に備えて、VSCode の簡単な使い方を説明しておきます。

また、Qiitaの「君はVS Codeのデバッグの知られざる機能について知っているか」は、あまりしられていない便利なデバッグ機能が紹介されていますので、本格的にプログラムをされる方は是非目を通しておいてください。

ワークスペースの概要と作成方法

ワークスペースとは、開発中のファイルやフォルダをひとまとまりに管理する場所を指します。VSCodeでワークスペースを作成すると、workspace.code-workspace という名前のJson形式のファイルが作成されます。

ワークスペースにフォルダを登録すると、このJsonファイルにフォルダのパスが登録され、その配下にあるファイルやフォルダが全て管理対象となります。

ワークスペースを開いた状態でファイルを作成すると、ワークスペースに登録したフォルダに保存してくれます。またVSCode起動時には、前回終了直後の状態を復元してくれるため、すぐに作業に取り掛かることができて便利です。

ワークスペースは「名前を付けてワークスペースを保存」でいつでも作成できます。
作成時にワークスペースファイルの保存先を聞かれるので、任意のフォルダを指定してください。

次に、フォルダを登録します。あらかじめソースファイルを保存するフォルダを作成しておいて、
「フォルダーをワークスペースに追加」でそのフォルダを指定します。

以上で作業は完了です。以降は「新しいファイル」でPythonファイルを作成すると、すべて先ほど指定したフォルダに保存されるようになります。

ワークスペースに登録したフォルダの中身が階層的に表示され、ファイルをクリックするだけでファイルが編集状態になります。

ファイルを右クリックするとファイルに関するメニューが、空の部分で右クリックするとワークスペースに関するメニューが表示されます。

Pythonファイルは、「①ファイル⇒②新しいファイル⇒③ファイル名を入力後エンター⇒④ファイル名を確認⇒⑤ファイルの作成をクリック」で作成できます。

ファイルを作成したらすぐに編集状態になるので、プログラムを記述していきます。

右の▷ボタンをクリックすると、プログラムが実行できます。

実行中は画面下半分に実行状況や、プログラム内に記述した print 文の出力結果が随時表示されます。

任意の行にブレイクポイントを設定すると、プログラムがその行に到達した時、実行を中断できます。行番号の右を1回クリックすると赤い●が表示され、もう一度クリックすると消えます。

この赤い●がブレイクポイントで、いくつも指定することができます。

ブレイクポイントで実行を停止させるには、デバッグの実行（①⇒②⇒③⇒④⇒⑤）の順で指定します。ただしこれは最初だけで、次回からは（①⇒②）で実行可能です。

デバッグの実行を行うと、しばらくしてブレイクポイントでプログラムが停止します。

デバッグ実行ではブレイクポイントで処理を中断した後で、任意の計算式や関数、ステートメントを実行したり、変数の中身を確認することが可能です。

また、実行を再開するだけでなく、ステップ実行（１行ごとの実行と停止）やプログラムの再起動など、デバッグに便利な実行方法を使うことができます。

続行	中断した箇所から、プログラムの実行を続けます。
ステップオーバー	現在の行を実行後、次の行で実行を停止します。
ステップイン	現在の行を実行後、次の行で実行を停止します。その行が関数／メソッド呼び出しであれば、関数／メソッド内に入り、最初の行を実行して停止します。
ステップアウト	現在実行している関数／メソッドの終了まで処理を行い、関数／メソッドの呼び出し元の行に戻って実行を停止します。
再起動	最初からデバッグをやり直します。
停止	デバッグを終了します。