コードエディターでデータヒントを使用して変数の値を表示および変更する

[アーティクル]
09/06/2024

この記事では、Visual Studio で DataTips 機能を使用する方法について説明します。データヒントは、コードをデバッグするときにプログラム内の変数に関する情報を表示する便利な方法を提供します。コードにブレークポイントを設定してデバッグを開始すると、変数が現在の実行範囲に入るとデータヒントが表示されます。データヒントを使用してスコープ内の変数の値を変更し、ブレークポイントでコードを再実行して変更の効果を確認できます。

ヒント

デバッグを初めて行う場合は、この記事を読む前に、「初心者のためのデバッグ」と「デバッグのテクニックとツール」を読むことをお勧めします。

前提条件

見ることができます。 Visual Studio をお持ちでない場合は、Visual Studio のダウンロードページに移動し、無料試用版をインストールしてください。
Visual Studio デバッガーで実行するプログラムコード。

データヒントを使用する

コードにブレークポイントが設定されている場合、デバッグセッション中にデータヒントが表示されます。デバッガーがブレークポイントでプログラムの実行を一時停止すると、現在のスコープ内のすべての変数に対してデータヒントが利用できるようになります。

そのプロセスを次に示します。

コードにブレークポイントを設定し、 デバッグ>デバッグの開始 を選択するか、F5 キーボードショートカットを使用してデバッグを開始します。
デバッガーがブレークポイントで実行を一時停止したら、現在のスコープ内の任意の変数にマウスを移動してデータヒントを開きます。
データヒントを使用して変数の名前を確認し、値を操作します。
必要に応じて、変数の値を変更したり、コメントを追加したりします。

Note

Visual Studio は、デバッガーが実行時に一時停止されているコンテキストに基づいて、変数の値を評価し、データヒントに表示します。評価は、カーソルまたはデータヒントの現在の位置に基づいて行われません。現在のコンテキスト内の変数と同じ名前を持つ別の関数内の変数にマウスポインターを合わせると、Visual Studio は現在のコンテキストのデータヒントにその変数の値を表示します。

Visual Studio は、データヒントや変数と値の操作に関する次のような多くのアクションをサポートしています。

コードの実行が継続している間、データヒントを表示し続けるためにピン留めまたはフロートします。
他の場所を選択するまで展開されたままになる固定データヒントを有効にする
配列、構造体、またはオブジェクトのデータヒントを展開して、そのメンバーをツリー形式で表示します。
データヒントの変数の値を変更する
デバッグ中にメモを取るために、固定されたデータヒントに複数行のコメントを追加します。
データヒントをインポートおよびエクスポートする

データのヒントを透明化する

変数の上にマウスを置いてデータヒントを表示すると、データヒントを透明にして、その下のコードを表示できます。このアクションは、メソッド定義や式の構文など、コードエディター内の他のヒントアクションの透明度もオンにします。

透明性を有効にするには、次の手順に従います。

Visual Studio Code エディターで、データヒント内を選択し、Ctrl キーを押したままにします。
透明性を維持するには、Ctrl キーを押し続けます。
透明化を終了するには、Ctrl キーの選択を停止するか、別の場所を選択します。

ピン留めされたデータヒントやフローティングデータヒントでは透明度は使用できません。

データのヒントを拡張したままにする

Visual Studio 2022 Update 1 以降では、データヒントを展開すると、他の場所を選択するまで展開された状態を維持できます。このアクションにより、固定データヒントが生成されます。

データヒントを固定するには、次の手順に従います。

Visual Studio で、 デバッグ>オプション を選択して、 オプション ダイアログを開きます。
「全般」 タブで、スクロールして 「展開されたデータヒントはクリックして閉じるまで開いたままにする」 オプションを見つけます。
チェックボックスを選択してスティッキーオプションを有効にし、 OKを選択します。

スティッキーオプションを有効にすると、コードエディターでデータヒントを展開すると、展開されたままになります。

データヒントをピン留めする

データヒントをピン留めして、コードエディターの画面上に開いたままにすることができます。ピン留めされたデータヒントの場所を変更することもできます。

データヒントをピン留めするには、次の手順に従います。

Visual Studio Code エディターで、変数の上にマウスカーソルを置くと、データのヒントが表示されます。
データヒントで、プッシュピンを使用して ソースにピン留めを選択します。

Visual Studio は、コードサーフェイス上の変数の近くの場所にデータヒントを固定します。データヒントをピン留めした行の横のコードエディターの余白に、プッシュピンが表示されます。
固定されたデータヒントを選択し、コードエディターサーフェス上の任意の場所にドラッグします。

フロート（ピン留め解除）データのヒント

データヒントをピン留めした後、データヒントのピン留めを解除して フロートにすることができます。フローティングデータヒントは、Visual Studio IDE 内の任意の場所に配置できます。

データヒントをフロートするには、次の手順に従います。

ピン留めされたデータヒントで、プッシュピンを使用して ソースからピン留めを解除を選択します。

Visual Studio はデータヒントの固定を解除し、データヒントに単色の背景を設定します。データヒントのプッシュピンがピン留めされていない位置に変わり、コードエディターのガター内のプッシュピンが削除されます。
フローティングデータヒントを選択し、Visual Studio IDE 内の任意の場所にドラッグします。

フローティングデータヒントをコードエディターサーフェスの外側に配置すると、プッシュピンはデータヒントのサイドメニューから削除されます。 ソースにピン留め オプションは、フローティングデータヒントがコードエディターサーフェス上に配置されている場合にのみ使用できます。

データの再ピンのヒント

データヒントをフローティングした後、コードエディターサーフェス上の特定のソースの場所に再度ピン留めすることができます。

フローティングデータヒントを再ピン留めするには、次の手順に従います。

フローティングデータヒントを選択して移動し、コードエディターサーフェス上に配置します。
フローティングデータヒントで、プッシュピンを使用して ソースにピン留めを選択します。

プッシュピンが固定位置に変わります。データヒントはコードエディターの特定の場所に再度ピン留めされ、ソースのプッシュピンがコードエディターのガターに表示されます。

データのヒントを閉じる

Visual Studio でデータヒントを閉じる方法はいくつかあります。

デバッグセッションを終了するときに、開いているデータヒントがある場合は、Visual Studio によって自動的に閉じられます。別のデバッグセッションを起動すると、Visual Studio は以前に開いたままにしたデータヒントを再確立しようとします。

次の表は、データヒントを手動で閉じる方法をまとめたものです。

ターゲットを閉じる	アクション
データ別のヒント	データヒントで X を選択します。
特定のファイルのすべてのデータヒント	Visual Studio ツールバーでデバッグ>「<ファイル名> に固定されたすべてのデータヒントをクリア」を選択します。
すべてのオープンデータのヒント	Visual Studio ツールバーでデバッグ>すべてのデータヒントをクリアを選択します。

データヒントの変数と値を操作する

Visual Studio でデータヒントを使用すると、変数やオブジェクトの詳細を表示したり、デバッグ中に値を編集したりできるようになります。これらの機能は、コードの変更を迅速にトラブルシューティングしたりテストしたりするのに役立ちます。

データヒント内のオブジェクトを展開してメンバーを表示します

データヒントが配列、構造体、またはオブジェクトを表す場合は、データヒントビューを展開してメンバーを表示できます。拡張ビューでは、追加情報が階層ツリー形式で表示されます。

データヒント内のオブジェクトのビューを展開するには、次の手順に従います。

配列、構造体、またはオブジェクトのデータヒントで、項目名の前の展開矢印を選択すると、メンバーが表示されます。ビューはツリー形式で表示されます。

固定されたデータヒントの場合は、変数名の前のプラス記号 (+) を選択して定義を展開します。
メンバー階層をさらに表示するには、展開矢印を選択し続けます。
拡大表示内で上下に移動するには、マウスまたはキーボードの上下矢印キーを使用します。
展開されたメンバーを元の固定データヒントで固定するには、メンバーのプッシュピンを使用して ソースに固定 を選択します。ツリービューを折りたたんだ後も、固定されたメンバー要素は固定されたデータヒントとともに表示されたままになります。

変数値を編集する

DataTips を使用するもう 1 つの利点は、デバッグ中にデータヒント内の変数または要素の値を編集できることです。この機能は、コードへの小さな変更をすばやくテストするのに役立ちます。

データヒント内の変数または要素の値を編集するには、次の手順に従います。

データヒントで値を選択します。 Visual Studio は値を強調表示し、編集できるようにします。
データヒントに新しい値を入力し、 Enterを選択します。

一部の変数値は読み取り専用であることに注意してください。 Visual Studio では、読み取り専用の値は編集できません。

データヒントのコメントを使用する

データヒントの コメント 領域は、コードをデバッグするときに変数に関するメモを残すのに役立ちます。この領域は、デバッグ中に変化するさまざまな値を追跡するのに便利な場所です。固定されたデータヒントまたはフローティングデータヒントにコメントを追加できます。

データヒントで コメント を使用するには、次の手順に従います。

データヒントで、二重の下矢印を使用して [展開してコメントを表示]を選択します。二重下矢印をクリックすると、データヒントの コメント 領域が開き、メモを追加できます。
コメントを追加するには、 コメント 領域にカーソルを置き、テキストを入力します。リージョンは複数の行を受け入れます。
コメント 領域を閉じるには、二重の上矢印を使用して コメントを折りたたみます。入力したコメントはデータヒントに残りますが、現在は表示されません。

データヒントのプロパティをピン留めする

Visual Studio は、.NET Core 3.0 以降のピン留めされたデータヒントのプロパティのピン留めをサポートしています。この機能を使用すると、データヒント内のプロパティによってオブジェクトをすばやく検査できます。

データヒントにプロパティをピン留めするには、次の手順に従います。

固定されたデータヒントで、データヒントとともに表示したままにしておくプロパティが表示されるまで、メンバーの階層を展開します。
プロパティのプッシュピンを使用して、データヒントで固定します。プロパティを右クリックして、 「メンバーをお気に入りとしてピン留めする」を選択することもできます。

Visual Studio は、選択したプロパティをオブジェクトのプロパティリストの先頭に移動します。プロパティ名と値は、固定されたデータヒントの右側の列に表示されます。
データヒントのプロパティのピン留めを解除するには、プロパティのプッシュピンを再度選択するか、プロパティを右クリックして [メンバーをお気に入りとしてピン留め解除]を選択します。

プロパティ名の表示を切り替えたり、データヒントのオブジェクトのプロパティリストで固定されていないプロパティを除外したりすることもできます。

固定されていないプロパティを除外するには、データヒントのプロパティ行を右クリックし、 [固定されたメンバーのみを表示]を選択します。
プロパティ名の表示を切り替えるには、データヒントのプロパティ行を右クリックし、 「値内の固定メンバー名を非表示にする」を選択します。

次の画像は、データヒントのメンバー階層の右クリックメニューのさまざまなオプションを示しています。

AI による支援を得る

Copilot をお持ちの場合は、データのヒントの変数を見ている間に AI による支援を受けることができます。変数を右クリックし、[Copilot に質問する] ボタンを使用します。このシナリオでは、Copilot は質問のコンテキストを既に認識しているため、ご自分でコンテキストをチャットで提供する必要はありません。詳細については、「Copilot を使用したデバッグ」を参照してください。

複合データ型を視覚化する

ビジュアライザーは、情報をよりわかりやすく、場合によってはグラフィカルな方法で表示します。ビジュアライザーの例としては、XML、HTML、JSON、テキストビジュアライザーなどがあります。視覚化を使用すると、デバッグ中にコード内の複雑なデータ型を調べることができます。

要素に対してビジュアライザーが使用可能な場合、Visual Studio ではデータヒントの要素名の横に View 虫眼鏡が表示されます。視覚化を選択すると、Visual Studio は別のウィンドウを開き、複雑なデータを読み取り可能な形式で表示します。

この機能を使用して、データの視覚化を選択できます。

データ型のデフォルトのビジュアライザーを使用して要素を表示するには、虫眼鏡を選択します。
特定のビジュアライザーを選択するには、虫眼鏡の横にある [表示] ドロップダウンリストを展開し、オプションを選択します。

ウォッチウィンドウに変数を追加する

データヒントから Visual Studio の ウォッチ ウィンドウに変数を追加することで、引き続き変数を監視することができます。

データヒントで変数名を右クリックし、 [ウォッチの追加]を選択します。

Visual Studio は ウォッチ ウィンドウに変数を追加します。 Visual Studio エディションが複数の ウォッチ ウィンドウをサポートしている場合、変数は ウォッチ 1というラベルの付いたウィンドウに表示されます。

データヒントをインポートおよびエクスポートする

データヒントを XML ファイルにエクスポートし、テキストエディターを使用して共有したり編集したりできます。受信した XML ファイルまたは以前に編集した XML ファイルからデータヒントをインポートすることもできます。

データのヒントをエクスポートするには、次の手順に従います。

Visual Studio で、 デバッグ>データヒントのエクスポートを選択します。 データヒントのエクスポート ダイアログが開きます。
ダイアログで、XML ファイルを保存する場所を参照します。
エクスポートファイルの名前を入力し、 [保存]を選択します。

Visual Studio は、データヒントを指定されたファイルと場所にエクスポートします。

ファイルからデータヒントをインポートするには、次の手順に従います。

Visual Studio で、 デバッグ>データヒントのインポートを選択します。 データヒントのインポート ダイアログが開きます。
ダイアログで、インポートに使用するデータヒント XML ファイルの場所を参照します。
開くファイルを選択し、開くを選択します。

Visual Studio は、指定されたファイルからデータヒントを現在のワークスペースにインポートします。ワークスペースコードをデバッグすると、インポートされたデータのヒントが利用できるようになります。

次の方法で共有

コードエディターでデータヒントを使用して変数の値を表示および変更する

前提条件