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

  • [アーティクル]

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

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

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

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

前提条件

Visual Studio をインストールし、C++ によるデスクトップ開発ワークロードを用意する必要があります。

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

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

Visual Studio は既にあり、ワークロードだけをインストールする必要がある場合は、 [ツール]>[ツールと機能を取得] に移動すると、Visual Studio インストーラーが開きます。 Visual Studio インストーラーが起動します。 [C++ によるデスクトップ開発] ワークロード、 [変更] の順に選択します。

プロジェクトの作成

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

  1. Visual Studio を開きます。

    スタート ウィンドウが開いていない場合は、 [ファイル]>[スタート ウィンドウ] を選択します。

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

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

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

    Screenshot of choosing the C++ template for the Console App.

    Screenshot of choosing the C++ template for the Console App.

    Note

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

  4. [新しいプロジェクトの構成] ウィンドウの [プロジェクト名] ボックスに「get-started-debugging」とタイプまたは入力します。 次に、 [作成] を選択します。

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

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

  1. get-started-debugging.cpp で、既定のコードのすべてを次のコードに置き換えます。

    #include <string>
#include <vector>
#include <iostream>

void SendMessage(const std::wstring& name, int msg)
{
    std::wcout << L"Hello, " << name << L"! Count to " << msg << std::endl;
}

int main()
{
    std::vector<wchar_t> letters = { L'f', L'r', L'e', L'd', L' ', L's', L'm', L'i', L't', L'h' };
    std::wstring name = L"";
    std::vector<int> a(10);
    std::wstring key = L"";

    for (int i = 0; i < letters.size(); i++)
    {
        name += letters[i];
        a[i] = i + 1;
        SendMessage(name, a[i]);
    }
    std::wcin >> key;
    return 0;
}

デバッガーを起動する

  1. F5 キーを押すか ([デバッグ] > [デバッグの開始])、[デバッグ] ツール バーの [デバッグの開始] ボタン Start Debugging を選択します。

    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. 赤い停止 Stop Debugging ボタン (Shift キー + F5) を押してデバッガーを停止します。

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

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

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

    name += letters[i];

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

    ブレークポイントは、信頼できるデバッグの最も基本的で重要な機能の 1 つです。 ブレークポイントは、Visual Studio が実行コードを中断する場所を示します。これにより、変数の値またはメモリの動作を確認したり、コードの分岐が実行されるかどうかを確認したりすることができます。

  2. F5 キーを押すか、または [デバッグの開始] ボタン Start Debugging を選択します。アプリが起動され、デバッガーが実行されてブレークポイントを設定したコード行まで進みます。

    Screenshot of setting and hitting a breakpoint.

    黄色の矢印はデバッガーが一時停止しているステートメントを表します。デバッガーの一時停止によってアプリの実行も同じポイントで中断されます (このステートメントはまだ実行されていません)。

    アプリがまだ実行されていない場合、F5 キーを押すとデバッガーが起動し、最初のブレークポイントで停止します。 それ以外の場合、F5 キーを押すと、アプリの実行が続行され、次のブレークポイントまで進みます。

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

ほとんどの場合、ここではキーボード ショートカットを使用します。それはデバッガーでご自分のアプリをすばやく実行するのに便利な方法だからです (コマンド メニューなどの対応するコマンドはかっこ内に示します)。

  1. main メソッド内の for ループで一時停止している間に、F11 キーを 2 回押して (または [デバッグ] > [ステップ イン] を選択して)、SendMessage メソッドの呼び出しに進みます。

    F11 キーを 2 回押したら、次のコード行が表示されるはずです。

    SendMessage(name, a[i]);

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

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

    Screenshot of using F11 to Step Into code.

    F11 キーは [ステップ イン] コマンドであり、アプリの実行が一度に 1 ステートメント進められます。 F11 キーは実行フローを最も詳しく確認することができる便利な方法です。 (他にコード内をより速く移動するためのオプションについても紹介します)既定では、非ユーザー コードはデバッガーによってスキップされます (詳細については、マイ コードのみに関するページを参照)。

    たとえば、SendMessage メソッドの確認を終了しました。そこで、このメソッドからは抜け出したいけれども、デバッガーには留まっていたいとします。 これを行うには、[ステップ アウト] コマンドを使用します。

  3. Shift + F11 キーを押します (または [デバッグ] > [ステップ アウト] の順に選択します)。

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

    SendMessage メソッド呼び出しで一時停止している、main メソッド内の for ループに戻る必要があります。

  4. SendMessage メソッドの呼び出しに再び戻るまで、F11 キーを何度か押します。

  5. メソッドの呼び出しで一時停止している間に、一度、F10 キーを押します (または、[デバッグ] > [ステップ オーバー] の順に選択します)。

    Screenshot of using F10 to Step Over code.

    今回は、デバッガーが SendMessage メソッドにステップ インしていないことに注目してください。 F10 キーを押すと、ご利用のアプリのコード内の関数またはメソッドにステップ インすることなく、デバッガーが進められます (コードはまだ実行されています)。 SendMessage メソッド呼び出し上で (F11 キーではなく) F10 キーを押して、SendMessage 用の実装コードをスキップしました (現時点で関係ないと思われるため)。 ご利用のコード内を移動するさまざまな方法の詳細については、デバッガーでのコード間の移動に関するページを参照してください。

  1. F5 キーを押して、ブレークポイントに進みます。

  2. コード エディターで、下にスクロールし、緑色の [クリックで実行] ボタン クリック Run to Click が左側に表示されるまで、SendMessage メソッドの std::wcout 関数の上にマウス ポインターを置きます。 ボタンのヒントには、[ここまで実行します] と表示されます。

    Screenshot of using the Run to Click feature.

    Note

    [Run to Click]\(クリックで実行\) ボタンは Visual Studio 2017 の新機能です。 (緑色の矢印ボタンが表示されない場合、この例では代わりに F11 キーを使用してデバッガーを適切な場所まで進めます。)

  3. [クリックで実行] ボタン Run to Click をクリックします。

    デバッガーが std::wcout 関数に進みます。

    このボタンを使用することは、一時的なブレークポイントを設定することに似ています。 [クリックで実行] はアプリ コードの表示領域内をすばやく移動するのに便利です (開いている任意のファイル内でクリックすることができます)。

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

[デバッグ] ツール バーの [再起動]Restart App ボタンをクリックします (Ctrl + Shift + F5)。

[再起動] を押すと、アプリを停止してからデバッガーを再起動する場合と比較して時間の節約になります。 デバッガーは、コードを実行すると最初にヒットするブレークポイントで一時停止します。

デバッガーは、前に for ループ内に設定したブレークポイントで再び停止します。

データ ヒントを使用して変数を確認する

変数を調べることができる機能は、デバッガーの機能の中でも最も便利な機能の 1 つに挙げられ、それを行うにはさまざまな方法を利用できます。 多くの場合、問題のデバッグを試みるときは、特定のタイミングで変数に期待する値がそのとおりに変数に格納されているかどうかの確認を試みます。

  1. name += letters[i] ステートメントで一時停止しているときに、letters 変数にカーソルを合わせます。その既定値 size={10} が表示されます。

  2. letters 変数を展開してそのプロパティを表示します。これには変数が含むすべての要素が入っています。

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

  4. 数回、F5 キーを押して (または [デバッグ]、[続行] の順に選択して)、for ループを数回繰り返します。ブレークポイントで再び一時停止したら、name 変数にカーソルを合わせて毎回値を確認します。

    Screenshot of viewing a data tip.

    変数の値は、for ループが繰り返されるたびに変化し、表示される値は、f、次は fr、その次は fre という具合になります。

    デバッグ時に、変数のプロパティ値に期待どおりの値が格納されているかどうかをすばやく確認したい場合がよくあります。データ ヒントはそれを行うのに適した方法です。

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

  1. コード エディターの下部にある [自動変数] ウィンドウを見てください。

    ウィンドウが閉じている場合は、デバッガーが一時停止している間に、[デバッグ]>[ウィンドウ]>[自動変数] の順に選択します。

    [自動変数] ウィンドウには、変数とその現在の値が表示されます。 [自動変数] ウィンドウには、現在の行または前の行で使用されるすべての変数が表示されます (言語固有の動作についてはドキュメントを参照してください)。

  2. 次に、[自動変数] ウィンドウの隣にあるタブ内の [ローカル] ウィンドウを見てください。

  3. letters 変数を展開して、それに含まれている要素を表示します。

    Screenshot of inspecting variables in the Locals Window.

    Screenshot of inspecting variables in the Locals Window.

    [ローカル] ウィンドウを確認すれば、現在のスコープ (現在の実行コンテキスト) に含まれている変数がわかります。

ウォッチ式を設定する

  1. メインのコード エディター ウィンドウで、name 変数を右クリックして、[ウォッチ式の追加] を選択します。

    コード エディターの下部に [ウォッチ] ウィンドウが表示されます。 [ウォッチ] ウィンドウを使用することで、監視する変数 (または式) を指定できます。

    これで、name 変数に対してウォッチ式が設定されたので、デバッガー内を移動しながらその値の変化を確認することができます。 その他の変数ウィンドウとは異なり、[ウォッチ] ウィンドウには監視対象の変数が常に表示されます (対象外のときは淡色表示となります)。

呼び出し履歴を調べる

  1. for ループ内で一時停止しているときに、[呼び出し履歴] ウィンドウをクリックします。このウィンドウは既定では右下ペイン内に表示されます。

    ウィンドウが閉じている場合は、デバッガーが一時停止している間に、[デバッグ]>[ウィンドウ]>[呼び出し履歴] の順に選択します。

  2. デバッガーが SendMessage メソッド内で一時停止するのを確認できるまで、F11 キーを数回押します。 [呼び出し履歴] ウィンドウを見てください。

    Screenshot of examining the call stack.

    Screenshot of examining the call stack.

    [呼び出し履歴] ウィンドウには、メソッドおよび関数が呼び出されている順番が表示されます。 先頭行には、現在の関数が表示されます (このアプリでは SendMessage メソッド)。 2 行目には、SendMessage が main メソッドから呼び出されたことが表示され、後もこのような具合に表示されます。

    Note

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

    呼び出し履歴は、アプリの実行フローを調査して理解するのに優れた方法です。

    コード行をダブルクリックすることで、ソース コードに移動できます。また、それによって、デバッガーで検査されている現在のスコープを変更することもできます。 このアクションを行っても、デバッガーは前に進みません。

    [呼び出し履歴] ウィンドウから右クリック メニューを使用して他の操作を行うこともできます。 たとえば、指定した関数にブレークポイントを挿入したり、[カーソル行の前まで実行] を使用してデバッガーを進めたり、ソース コードの調査を開始したりできます。 詳細については、呼び出し履歴を調べる方法に関するページを参照してください。

実行フローを変更する

  1. F11 キーを 2 回押して、std::wcout 関数を実行します。

  2. SendMessage メソッド呼び出し内でデバッガーが一時停止した状態で、マウスを使用して左側にある黄色の矢印 (実行ポインター) をつかみ、その黄色の矢印を 1 行上に移動して、std::wcout に戻ります。

  3. F11 キーを押します。

    デバッガーにより std::wcout 関数が返されます (これはコンソール ウィンドウの出力に表示されます)。

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

    警告

    多くの場合、この機能には注意する必要があり、ツールヒントに警告が表示されます。 他の警告が表示される場合もあります。 ポインターを移動しても、ご利用のアプリを以前のアプリ状態に戻すことはできません。

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

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

次のステップ

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

デバッガーでのはじめに