チュートリアル: Visual Studio を使用した C# のデバッグについて理解する

この記事では、ステップ バイ ステップのチュートリアルで Visual Studio デバッガーの機能を紹介します。 デバッガー機能の概要を確認したい場合は、「デバッガーでのはじめに」を参照してください。 "アプリをデバッグする" 場合、通常、それはデバッガーをアタッチした状態でアプリケーションを実行することを意味します。 このタスクを行うとき、デバッガーには、コードの実行中に何が行われているかを確認するさまざまな方法が用意されています。 ご自分のコードをステップ実行して変数内に格納されている値を確認したり、変数に対してウォッチ式を設定して値が変わるタイミングを確認したり、コードの実行パスを調べたり、コードの分岐が実行されているかどうかを確認したりできます。 この演習が、コードのデバッグを行う初めての場合は、この記事を読み進める前に、「初心者向けのデバッグ方法」を参照することをお勧めします。

デモ アプリは C# ですが、ほとんどの機能は C++、Visual Basic、F#、Python、JavaScript、および Visual Studio でサポートされているその他の言語にも適用されます (F# ではエディット コンティニュはサポートされていません。F# と JavaScript では、[自動変数] ウィンドウはサポートされていません)。 スクリーン ショットは C# になっています。

このチュートリアルでは、次の作業を行います。

• デバッガーを起動して、ブレークポイントにヒットします。
• デバッガー内でコードをステップ実行するコマンドについて学習します。
• データ ヒントおよびデバッガー ウィンドウ内で変数を確認します。
• 呼び出し履歴を調べる

必須コンポーネント

Visual Studio 2022 および .NET デスクトップ開発ワークロードをインストールしている必要があります。

Visual Studio をまだインストールしていない場合は、Visual Studio のダウンロード ページに移動し、無料試用版をインストールしてください。

既に Visual Studio があり、 .NET デスクトップ開発ワークロードがインストールされていない場合は、 [ツール]>[ツールと機能を取得] に移動して、Visual Studio インストーラーを起動します。 Visual Studio インストーラーで、 [.NET デスクトップ開発] ワークロード選択し、 [変更] を選択します。

プロジェクトを作成する

まず、.NET Core コンソール アプリケーション プロジェクトを作成します。 この種類のプロジェクトには、必要となるすべてのテンプレート ファイルが付属していますので、何も追加する必要はありません。

1. Visual Studio を開きます。 スタート ウィンドウが開いていない場合は、[ファイル]>[スタート ウィンドウ] を選びます。

2. [スタート ウィンドウ] で、 [新しいプロジェクトの作成] を選択します。

3. [新しいプロジェクトの作成] ウィンドウで、検索ボックスに「コンソール」と入力します。 次に、言語のリストから [C#] を選択して、プラットフォームのリストから [Windows] を選択します。

   言語およびプラットフォームのフィルターを適用してから、[コンソール アプリ] テンプレートを選んで、[次へ] を選びます。

   

   Note

   [コンソール アプリ] テンプレートが表示されない場合、[新しいプロジェクトの作成] ウィンドウからインストールすることができます。 **[お探しの情報が見つかりませんでしたか?]** メッセージで、 **[さらにツールと機能をインストールする]** リンクを選択します。 次に、Visual Studio インストーラーで、 [.NET デスクトップ開発] ワークロードを選択します。

4. [新しいプロジェクトの構成] ウィンドウの [プロジェクト名] ボックスに「GetStartedDebugging」と入力します。 次に、 [次へ] を選択します。

5. [追加情報] ウィンドウの [フレームワーク] ドロップダウン メニューで [.NET 8.0] が選ばれていることを確認し、[作成] を選びます。

Visual Studio によってその新しいプロジェクトが開かれます。

アプリケーションを作成する

Program.cs で、既定のすべてのコードを次のコードに置き換えます。

using System;

class ArrayExample
{
   static void Main()
   {
      char[] letters = { 'f', 'r', 'e', 'd', ' ', 's', 'm', 'i', 't', 'h'};
      string name = "";
      int[] a = new int[10];
      for (int i = 0; i < letters.Length; i++)
      {
         name += letters[i];
         a[i] = i + 1;
         SendMessage(name, a[i]);
      }
      Console.ReadKey();
   }

   static void SendMessage(string name, int msg)
   {
      Console.WriteLine("Hello, " + name + "! Count to " + msg);
   }
}

デバッガーを起動する

ここでは主にキーボード ショートカットを使用します。これは、デバッガーのコマンドを素早く実行するためです。 ツールバーやメニュー コマンドなど、同等のコマンドも記載されています。

1. デバッガーを起動するには、F5 キーを押すか、標準ツール バーの [デバッグ ターゲット] ボタンを選択するか、[デバッグ] ツール バーの [デバッグの開始] ボタンを選択するか、メニュー バーから [デバッグ]>[デバッグの開始] を選択します。

   

   F5 によりアプリが起動され、デバッガーがアプリのプロセスにアタッチされます。 コードを確認する特別なことは何もしていないので、アプリは最後まで実行され、コンソール出力が表示されます。

   Hello, f! Count to 1
   Hello, fr! Count to 2
   Hello, fre! Count to 3
   Hello, fred! Count to 4
   Hello, fred ! Count to 5
   Hello, fred s! Count to 6
   Hello, fred sm! Count to 7
   Hello, fred smi! Count to 8
   Hello, fred smit! Count to 9
   Hello, fred smith! Count to 10
   

2. デバッガーを停止するには、Shift + F5 キーを押すか、[デバッグ] ツール バーの [デバッグの停止] ボタンを選択するか、メニュー バーの [デバッグ]>[デバッグの停止] を選択します。

   

3. コンソール ウィンドウで、任意のキーを押してコンソール ウィンドウを閉じます。

ブレークポイントを設定し、デバッガーを開始する

1. Main 関数の for ループ内で、次のコード行の左余白をクリックして、ブレークポイントを設定します。

   name += letters[i];

   ブレークポイントを設定した場所に赤い円が表示されます。

   

   ブレークポイントは、信頼性の高いデバッグに不可欠な機能です。 ブレークポイントは、Visual Studio の実行コードを中断する場所に設定できます。これにより、変数の値またはメモリの動作を確認したり、コードの分岐が実行されるかどうかを確認したりすることができます。

2. デバッグを開始するには、F5 キーを押すか、標準ツールバーの [デバッグ ターゲット] ボタンを選択するか、[デバッグ] ツールバーの [デバッグの開始] ボタンを選択するか、メニュー バーの [デバッグ]>[デバッグの開始] を選択します。 アプリが起動し、ブレークポイントを設定したコード行までデバッガーが実行されます。

   

   黄色の矢印は、デバッガーが一時停止したステートメントを示しています。 アプリの実行は同じポイントで一時停止し、ステートメントはまだ実行されていません。

   アプリが実行されていないときに F5 キーを押すと、デバッガーが起動し、最初のブレークポイントに到達するまでアプリが実行されます。 アプリがブレークポイントで一時停止している場合に F5 キーを押すと、次のブレークポイントに到達するまでアプリの実行が継続されます。

   ブレークポイントは、詳細に調べたいコードの行またはセクションがわかっている場合に便利な機能です。 条件付きブレークポイントなど、設定できるさまざまな種類のブレークポイントの詳細については、ブレークポイントの使用に関するページを参照してください。

データ ヒントを利用し、コード内を移動してデータを検査する

1. コードの実行が name += letters[i] ステートメントで一時停止しているときに、letters 変数の上にマウス カーソルを合わせると、配列のサイズと要素の型 char[10] を示すデータ ヒントが表示されます。

   Note

   デバッガーの最も便利な機能の 1 つは、変数を検査する機能です。 問題をデバッグするときに、特定の時点で変数に想定する値が割り当てられているかどうかを確認することはよくあります。 データのヒントを表示することは、それを確認できる良い方法です。

2. letters 変数を展開すると、すべての配列要素とその値が表示されます。

   

3. name 変数にカーソルを合わせると、その現在の値である空の文字列が表示されます。

4. デバッガーを次のステートメントに進めるには、F10 キーを押すか、デバッグ ツール バーの [ステップ オーバー] ボタンを選択するか、メニュー バーの [デバッグ]>[ステップ オーバー] を選択します。 F10 キーをさらに 2 回押すと、SendMessage メソッド呼び出しを通過します。

   F10 キーを押すと、関数またはメソッドがステップ インされずにデバッガーが進みますが、コードは実行されます。 このように、現時点では関心のない SendMessage メソッドのコードのデバッグをスキップしました。

5. for のループを数回繰り返すには、F10 キーを繰り返し押します。 各ループの反復処理中に、ブレークポイントで一時停止し、name 変数にカーソルを合わせて、データ ヒントでその値を確認します。

   

   変数の値は、`for` ループが繰り返されるたびに変化し、表示される値は、`f`、次は `fr`、その次は `fre` という具合になります。 デバッガーでループをより速く通過させるには、代わりに F5 キーを押します。これで、次のステートメントではなくブレークポイントまで進みます。

6. コードの実行が Main メソッドの for ループで一時停止しているときに、SendMessage メソッド呼び出しに到達するまで F11 キーを押すか、[デバッグ] ツール バーの [ステップ イン] ボタンを選ぶか、メニュー バーの [デバッグ]>[ステップ イン] を選びます。

   デバッガーは次のコード行で一時停止します。

   SendMessage(name, a[i]);

7. SendMessage メソッドにステップ インするには、もう一度 F11 キーを押します。

   黄色のポインターが `SendMessage` メソッドに進みます。

   

   F11 キーは、コードの実行フローをより詳細に調べるのに役立ちます。 メソッド呼び出しからメソッドにステップ インするには、F11 キーを押します。 既定では、非ユーザー メソッドへのステップ インはデバッガーによってスキップされます。 非ユーザー コードのデバッグについては、マイ コードのみに関するページを参照してください。

   SendMessage メソッドのデバッグが完了したら、main メソッドの for ループに戻ることができます。

8. SendMessage メソッドを終了するには、Shift + F11 キーを押すか、[デバッグ] ツール バーの [ステップ アウト] ボタンを選択するか、メニュー バーの [デバッグ]>[ステップ アウト] を選択します。

   [ステップ アウト] を使用すると、アプリの実行が再開され (そしてデバッガーが前へ進められ)、現在のメソッドまたは関数から制御が戻るまで続けられます。

   黄色のポインターが Main メソッドの for ループに戻り、SendMessage メソッド呼び出しで一時停止しているのがわかります。 ご利用のコード内を移動するさまざまな方法の詳細については、[デバッガーでのコード間の移動](../../debugger/navigating-through-code-with-the-debugger.md)に関するページを参照してください。

[クリックで実行] を使用してコード内を移動する

1. F5 キーを押し、もう一度ブレークポイントまで進みます。

2. コード エディター内で、[クリックで実行] ボタンが表示されるまで、SendMessage メソッド内の Console.WriteLine メソッド呼び出しの上にマウス カーソルを合わせます。 ボタンのヒントには、[ここまで実行します] と表示されます。

   

3. [クリックで実行] ボタンを選択します。 または、Console.WriteLine ステートメントにカーソルを置き、Ctrl + F10 キーを押します。 または、Console.WriteLine メソッド呼び出しを右クリックし、コンテキスト メニューから [カーソル行の前まで実行] を選択します。

   デバッガーが Console.WriteLine メソッド呼び出しまで進みます。

   [クリックで実行] ボタンの使用は、一時的なブレークポイントの設定と似ており、開いているファイル内のアプリ コードの可視領域内をすばやく移動するのに便利です。

アプリを簡単に再起動する

デバッガーでアプリを最初から再実行するには、Ctrl + Shift + F5 キーを押すか、[デバッグ] ツール バーの [再起動] ボタンを選択するか、メニュー バーの [デバッグ]>[再起動] を選択します。

[再起動] を選択すると、1 回の手順でデバッガーが停止され、再起動されます。 デバッガーが再起動すると、最初のブレークポイント (for ループ内に以前に設定したブレークポイント) まで実行してから、一時停止します。

[自動変数] ウィンドウと [ローカル] ウィンドウを使用して変数を確認する

デバッグしている間、 [自動変数] ウィンドウと [ローカル] ウィンドウに変数の値が表示されます。 ウィンドウは、デバッグ セッション中にのみ使用できます。 [自動変数] ウィンドウには、デバッガーの現在の行とその前の行で使用されている変数が表示されます。 **[ローカル]** ウィンドウには、ローカル スコープ (通常は現在の関数またはメソッド) で定義されている変数が表示されます。

1. デバッガーが一時停止している状態で、コード エディターの下部にある [自動変数] ウィンドウを確認します。

   [自動変数] ウィンドウが閉じている場合は、Ctrl + D、A キーを押すか、メニュー バーの [デバッグ]>[ウィンドウ]>[自動変数] を選択します。

2. デバッガーを一時停止したまま、 [自動変数] ウィンドウの隣のタブで [ローカル] ウィンドウを確認します。

   [ローカル] ウィンドウが閉じている場合は、Ctrl + D、L キーを押すか、[デバッグ]>[ウィンドウ]>[ローカル] を選択します。

3. [ローカル] ウィンドウで letters 変数を展開すると、その配列要素と値が表示されます。

   

[自動変数] ウィンドウと [ローカル] ウィンドウの使用方法の詳細については、「[自動変数] と [ローカル] ウィンドウで変数を検査」を参照してください。

ウォッチ式を設定する

ウォッチ ウィンドウに追加することで、コードをステップ実行するときに監視する変数または式を指定できます。

1. デバッガーが一時停止している状態で name 変数を右クリックし、 [ウォッチの追加] を選択します。

   既定でコード エディターの下部にウォッチ ウィンドウが表示されます。

2. name 変数にウォッチを設定したので、コードをステップ実行し、for ループの反復ごとに name 変数の値が変化することを確認します。

   その他の変数ウィンドウとは異なり、ウォッチ ウィンドウには、監視対象の変数が常に表示されます。 スコープ外の変数は使用不可として表示されます。

ウォッチ ウィンドウの詳細については、ウォッチ ウィンドウを使用した変数の監視に関するページを参照してください。

呼び出し履歴を調べる

[呼び出し履歴] には、メソッドと関数が呼び出される順序が表示されるので、アプリの実行フローを理解するのに役立ちます。

1. [呼び出し履歴] ウィンドウは、デバッガーが for ループで一時停止しているときに表示されます。既定では、コード エディターの右下のペインに表示されます。

   [呼び出し履歴] ウィンドウが閉じている場合は、Ctrl+D、C キーを押すか、メニュー バーの [デバッグ]>[ウィンドウ]>[呼び出し履歴] を選択します。

   [呼び出し履歴] ウィンドウには、現在の Main メソッドに黄色のポインターが表示されます。

2. デバッガーが SendMessage メソッド内で一時停止するのを確認できるまで、F11 キーを数回押します。

   [呼び出し履歴] ウィンドウの一番上の行には現在の関数 (ここでは SendMessage メソッド) が表示されます。 2 行目には、SendMessage メソッドが Main メソッドから呼び出されたことが表示されます。

   

   Note

   [呼び出し履歴] ウィンドウは、Eclipse のような一部の IDE におけるデバッグ パースペクティブに似ています。

   [呼び出し履歴] ウィンドウでは、コード行をダブルクリックしてソース コードに移動できます。また、デバッガーで検査中の現在のスコープも変更されます。 このアクションではデバッガーは先に進みません。

   **[呼び出し履歴]** ウィンドウから右クリック メニューを使用して他の操作を行うこともできます。 たとえば、指定した関数にブレークポイントを挿入したり、 [カーソル行の前まで実行] を使用してデバッガーを進めたり、ソース コードに移動したりすることができます。

呼び出し履歴の詳細については、呼び出し履歴の確認方法に関するページを参照してください。

実行フローを変更する

デバッグ中に実行ポインターを動かしてアプリのフローを変えることができます。

1. for ループの SendMessage メソッド呼び出しでデバッガーが一時停止している状態で、F11 キーを 3 回押して SendMessage メソッドにステップ インし、実行後に Console.WriteLine メソッドを通過します。

   これで、デバッガーは SendMessage メソッドの最後の閉じかっこの位置で一時停止した状態になります。

2. マウスを使用して黄色の矢印または実行ポインター (左余白) をつかみ、ポインターを 1 行上にドラッグします。

   デバッガーは Console.WriteLine ステートメントに戻ります。

3. F11 キーを押します。

   デバッガーで Console.WriteLine メソッドが再実行されると、コンソール ウィンドウの出力に同じ行が重複して表示されます。

4. F5 キーを押してアプリの実行を続行します。

実行フローを変更することにより、さまざまなコード実行パスをテストしたり、デバッガーを再起動することなくコードを再実行したりできます。

警告

この機能の使用には注意が必要です。 実行ポインターのヒントに、意図しない結果が生じる可能性があるという警告が表示されます。 また、他の警告も表示されることがあります。 実行ポインターを移動させても、アプリケーションを以前の状態に戻すことはできません。

実行フローの変更については、ポインターを移動して実行フローを変更する方法に関するページを参照してください。

これでこのチュートリアルは完了です。

次のステップ

このチュートリアルでは、デバッガーを起動する方法、コードをステップ実行する方法、変数を確認する方法について学習しました。 必要に応じて、デバッガー機能の概要と、詳細情報へのリンクを取得します。

デバッガーでのはじめに