Merge pull request #13814 from Mikejo5000/mikejo-br25

JillGrant615 · web-flow · commit cb025ffe1720 · 2025-04-16T16:57:34.000-06:00
Refactor article on variable inspection
diff --git a/docs/debugger/autos-and-locals-windows.md b/docs/debugger/autos-and-locals-windows.md
@@ -1,7 +1,7 @@
 ---
 title: Inspect variables - Visual Studio debugger
 description: Inspect variables in the Autos and Locals windows while debugging in Visual Studio. The Autos and Locals windows show variable values while you are debugging.
-ms.date: 3/11/2025
+ms.date: 4/10/2025
 ms.topic: how-to
 f1_keywords:
   - vs.debug.autos
@@ -16,33 +16,86 @@ ms.subservice: debug-diagnostics
 ms.collection: ce-skilling-ai-copilot
 ---
 
-# Inspect variables in the Visual Studio debugger
+# Inspect variables and return values in the Visual Studio debugger
 
-Features that allow you to inspect variables are some of the most useful features of the debugger, and there are different ways to do it. Often, when you try to debug an issue, you are attempting to find out whether variables are storing the values that you expect them to have in a particular app state.
+When you try to debug an issue, you're often attempting to find out whether variables are storing the values that you expect them to have in a particular app state. Some of the most useful features of the debugger are those that allow you to inspect variables.
 
-In this article, you'll learn how to inspect variables using the debugger in Visual Studio. The Visual Studio debugger provides several convenient ways to view variable values while debugging, including the following:
+This article shows you how to inspect variables and view return values using the debugger in Visual Studio. The debugger provides several convenient ways to perform these tasks, including the following:
 
-- Variable inspection windows (Autos, Locals, and Watch windows)
-- Data tips in the code editor
-- Inline return values
-- Visualizers for large strings or complex .NET objects
+- In the code editor, you can view data tips and inline return values
+- In debugger windows (Autos, Locals, and Watch windows), you can view variable values
+- In visualizers, you can view large strings or complex .NET objects
 
 These features are only available while debugging. To learn how to start a debugging session, see [Start debugging and enter break mode](../debugger/navigating-through-code-with-the-debugger.md#start-debugging-and-enter-break-mode).
 
 > [!NOTE]
 > If this is the first time that you've tried to debug code, you might want to read [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) and [Debugging techniques and tools](../debugger/write-better-code-with-visual-studio.md) before going through this article.
 
-## Inspect variables in the Autos and Locals windows
+## View variables in the code editor
 
-The **Autos** and **Locals** windows show variable values while you are debugging. The windows are only available during a debugging session. The **Autos** window shows variables used around the current statement where the debugger is paused. The **Locals** window shows variables defined in the local scope, which is usually the current function or method.
+Often, when debugging, you want a quick way to check property values on objects in the code editor, and the data tips are a good way to do it.
+
+While paused in the debugger, hover over an object with the mouse and you see its value, or its default property value.
+
+::: moniker range=">= vs-2022"
+![View a Data Tip](../debugger/media/vs-2022/dbg-tour-data-tips.png "View a data tip")
+::: moniker-end
+::: moniker range="<= vs-2019"
+![View a Data Tip](../debugger/media/dbg-tour-data-tips.gif "View a data tip")
+::: moniker-end
+
+If the variable has properties, you can expand the object to see all its properties.
+
+For detailed information on using data tips, see [View data values in data tips](../debugger/view-data-values-in-data-tips-in-the-code-editor.md).
+
+::: moniker range=">= vs-2022"
+## View inline return values of method calls in the code editor
+
+In .NET and C++ code, you can examine return values when you step over or out of a method call, which can be useful when the return value isn't stored in a local variable. A method could be used as a parameter, or as the return value of another method.
+
+Starting in Visual Studio 2022 version 17.12, you can view return values of method calls inline and not just in the [Autos window](#view-return-values-in-the-autos-window).
+
+[ ![Screenshot showing the return values of method calls.](../debugger/media/vs-2022/view-return-values.png) ](../debugger/media/vs-2022/view-return-values.png#lightbox)
+
+With Copilot enabled, you can also get targeted assistance related to the inline return value by using the Ask Copilot button that appears in the data tip for the return value.
+
+[ ![Screenshot showing the return values of method calls with Copilot icon.](../debugger/media/vs-2022/view-return-values-copilot.png) ](../debugger/media/vs-2022/view-return-values-copilot.png#lightbox)
+::: moniker-end
+
+## Set a watch on variables
+
+You can use a **Watch** window to specify a variable (or an expression) that you want to keep an eye on.
+
+While debugging, right-click an object in the code editor and choose **Add Watch**. A Watch window opens.
+
+::: moniker range=">= vs-2022"
+![Watch Window](../debugger/media/vs-2022/dbg-tour-watch-window.png "Watch window")
+::: moniker-end
+::: moniker range="<= vs-2019"
+![Watch Window](../debugger/media/dbg-tour-watch-window.png "Watch window")
+::: moniker-end
+
+In this example, you've a watch set on the object, and you can see its value change as you move through the debugger. Unlike the other variable windows, the **Watch** windows always show the variables that you're watching (they're grayed out when out of scope).
+
+For detailed information, see [Set a Watch using the Watch and QuickWatch Windows](../debugger/watch-and-quickwatch-windows.md).
+
+::: moniker range=">= vs-2022"
+## Get AI assistance
+
+If you have [Copilot](../ide/visual-studio-github-copilot-extension.md), you can get AI assistance while you're looking at variables in the code editor or in the Autos or Locals windows. While you're debugging, right-click on a variable and use the **Ask Copilot** ![Screenshot of Ask Copilot button.](../debugger/media/vs-2022/debug-with-copilot-ask-copilot-button.png) button. In this scenario, Copilot already knows the context for your question, so you don't need to provide context yourself in chat. For more information, see [Debug with Copilot](../debugger/debug-with-copilot.md).
+::: moniker-end
+
+## Inspect variables in debugger windows (Autos and Locals)
+
+The **Autos** and **Locals** windows show variable values while you're debugging. The windows are only available during a debugging session. The **Autos** window shows variables used around the current statement where the debugger is paused. The **Locals** window shows variables defined in the local scope, which is usually the current function or method.
 
 - To open the **Autos** window, while debugging, select **Debug** > **Windows** > **Autos**, or press **Ctrl**+**Alt**+**V** > **A**.
 
   The **Autos** window is available for C#, Visual Basic, C++, and Python code, but not for JavaScript or F#.
 
 - To open the **Locals** window, while debugging, select **Debug** > **Windows** > **Locals**, or press **Alt**+**4**.
 
-Arrays and objects show in the **Autos** and **Locals** windows as tree controls. Select the arrow to the left of a variable name to expand the view to show fields and properties. Here is an example of a <xref:System.IO.FileStream?displayProperty=fullName> object in the **Locals** window:
+Expandable arrays and objects show up in the **Autos** and **Locals** windows. Select the arrow to the left of a variable name to expand the view to show fields and properties. Here is an example of a <xref:System.IO.FileStream?displayProperty=fullName> object in the **Locals** window:
 
 ::: moniker range=">= vs-2022"
 ![Screenshot of the Locals window, with file set to a System.IO.FileStream value.](../debugger/media/vs-2022/locals-filestream.png)
@@ -55,7 +108,7 @@ A red value in the **Locals** or **Autos** window means the value has changed si
 
 The default numeric format in debugger windows is decimal. To change it to hexadecimal, right-click in the **Locals** or **Autos** window and select **Hexadecimal Display**. This change affects all debugger windows.
 
-### Edit variable values in the Autos or Locals window
+## Edit variable values in the Autos or Locals window
 
 To edit the values of most variables in the **Autos** or **Locals** windows, double-click the value and enter the new value.
 
@@ -66,11 +119,11 @@ In native C++ code, you might have to qualify the context of a variable name. Fo
 >[!CAUTION]
 > Make sure you understand the consequences before you change values and expressions. Some possible issues are:
 >
->- Evaluating some expressions can change the value of a variable or otherwise affect the state of your program. For example, evaluating `var1 = ++var2` changes the value of both `var1` and `var2`. These expressions are said to have [side effects](https://en.wikipedia.org/wiki/Side_effect_\(computer_science\)). Side effects can cause unexpected results if you are not aware of them.
+>- Evaluating some expressions can change the value of a variable or otherwise affect the state of your program. For example, evaluating `var1 = ++var2` changes the value of both `var1` and `var2`. These expressions are said to have [side effects](https://en.wikipedia.org/wiki/Side_effect_\(computer_science\)). Side effects can cause unexpected results if you're not aware of them.
 >
 >- Editing floating-point values can result in minor inaccuracies because of decimal-to-binary conversion of fractional components. Even a seemingly harmless edit can result in changes to some of the bits in the floating-point variable.
 
-### Search in the Autos or Locals window
+## Search in the Autos or Locals window
 
 You can search for keywords in the Name, Value, and Type columns of the **Autos** or **Locals** window using the search bar above each window. Hit ENTER or select one of the arrows to execute a search. To cancel an ongoing search, select the "x" icon in the search bar.
 
@@ -85,7 +138,7 @@ Use the left and right arrows (Shift+F3 and F3, respectively) to navigate betwee
 
 To make your search more or less thorough, use the **Search Deeper** dropdown list at the top of the **Autos** or **Locals** window to select how many levels deep you want to search into nested objects.
 
-### Pin properties in the Autos or Locals window
+## Pin properties in the Autos or Locals window
 
 > [!NOTE]
 > This feature is supported for .NET Core 3.0 or higher.
@@ -100,7 +153,7 @@ You can also toggle property names and filter out non-pinned properties when vie
 
 ![Screenshot of Toggle property names.](../debugger/media/toggle-property-names.gif "Toggle property names")
 
-### Change the context for the Autos or Locals window
+## Change the context for the Autos or Locals window
 
 You can use the **Debug Location** toolbar to select a desired function, thread, or process, which changes the context for the **Autos** and **Locals** windows.
 
@@ -115,7 +168,7 @@ Set a breakpoint and start debugging. When the breakpoint is hit, execution paus
 ![Screenshot of Debug Location toolbar.](../debugger/media/debuglocationtoolbar.png "Debug Location toolbar")
 ::: moniker-end
 
-### <a name="bkmk_whatvariables"></a> Language differences in the Autos window (C#, C++, Visual Basic, Python)
+## <a name="bkmk_whatvariables"></a> Language differences in the Autos window (C#, C++, Visual Basic, Python)
 
 Different code languages display different variables in the **Autos** window.
 
@@ -168,51 +221,7 @@ Different code languages display different variables in the **Autos** window.
 
     The variable `e` is uninitialized, because the line `e = 5` has not yet been executed.
 
-## View data tips
-
-Often, when debugging, you want a quick way to check property values on objects in the code editor, and the data tips are a good way to do it. For detailed information on using data tips, see [View data values in data tips](../debugger/view-data-values-in-data-tips-in-the-code-editor.md).
-
-While paused in the debugger, hover over an object with the mouse and you see its value, or its default property value.
-
-::: moniker range=">= vs-2022"
-![View a Data Tip](../debugger/media/vs-2022/dbg-tour-data-tips.png "View a data tip")
-::: moniker-end
-::: moniker range="<= vs-2019"
-![View a Data Tip](../debugger/media/dbg-tour-data-tips.gif "View a data tip")
-::: moniker-end
-
-If the variable has properties, you can expand the object to see all its properties.
-
-## Set a watch on variables
-
-You can use a **Watch** window to specify a variable (or an expression) that you want to keep an eye on. For detailed information, see [Set a Watch using the Watch and QuickWatch Windows](../debugger/watch-and-quickwatch-windows.md).
-
-While debugging, right-click an object and choose **Add Watch**.
-
-::: moniker range=">= vs-2022"
-![Watch Window](../debugger/media/vs-2022/dbg-tour-watch-window.png "Watch window")
-::: moniker-end
-::: moniker range="<= vs-2019"
-![Watch Window](../debugger/media/dbg-tour-watch-window.png "Watch window")
-::: moniker-end
-
-In this example, you have a watch set on the object, and you can see its value change as you move through the debugger. Unlike the other variable windows, the **Watch** windows always show the variables that you are watching (they're grayed out when out of scope).
-
-## View return values of method calls
-
-In .NET and C++ code, you can examine return values in the **Autos** window when you step over or out of a method call, which can be useful when the return value is not stored in a local variable. A method could be used as a parameter, or as the return value of another method.
-
-::: moniker range=">= vs-2022"
-Starting in Visual Studio 2022 version 17.12 Preview 3, you can also view return values of method calls inline and not just in the Autos window.
-
-[ ![Screenshot showing the return values of method calls.](../debugger/media/vs-2022/view-return-values.png) ](../debugger/media/vs-2022/view-return-values.png#lightbox)
-
-With Copilot enabled, you can also get targeted assistance related to the inline return value by using the Ask Copilot button that appears in the data tip for the return value.
-
-[ ![Screenshot showing the return values of method calls with Copilot icon.](../debugger/media/vs-2022/view-return-values-copilot.png) ](../debugger/media/vs-2022/view-return-values-copilot.png#lightbox)
-::: moniker-end
-
-### View return values in the Autos windows
+## View return values in the Autos window
 
 In the following example, this C# code adds the return values of two functions:
 
@@ -251,14 +260,14 @@ To see the return values of the `sumVars()` and `subtractVars()` method calls in
    ![Screenshot of Autos return value C#.](../debugger/media/autosreturnvaluecsharp2.png "Autos return value C#")
    ::: moniker-end
 
-## Inspect variables in a visualizer
+## Open a visualizer to inspect variables
 
-While you are debugging in Visual Studio, you can view large strings or complex objects with built-in visualizers that make the data easier to inspect. For example:
+While you're debugging in Visual Studio, you can view large strings or complex objects with built-in visualizers that make the data easier to inspect. For example:
 
 - The string visualizer shows text, XML, HTML, and JSON strings that are too long for a data tip or debugger window. It can also help you identify malformed strings. For more information, see [View strings in a string visualizer](../debugger/view-strings-visualizer.md). 
 - The DataSet and IEnumerable visualizers show .NET collection objects in a tabular visualizer. For more information, see [Tabular visualizers in Visual Studio](../debugger/view-data-in-tabular-visualizer.md)) objects.
 
-The visualizers appear in the **Autos** windows and other debugger windows.
+The visualizers appear in the **Autos** windows, data tips, and other debugger windows.
 
 > [!NOTE]
 > If you need to inspect XAML or WPF UI elements in a visualizer, see or [Inspect XAML properties while debugging](../xaml-tools/inspect-xaml-properties-while-debugging.md) or [How to use the WPF tree visualizer](../debugger/how-to-use-the-wpf-tree-visualizer.md).
@@ -272,12 +281,6 @@ To open a visualizer, you must be paused during debugging. Hover over a variable
 ![Open a string visualizer](../debugger/media/dbg-tips-string-visualizers.png "Open string visualizer")
 ::: moniker-end
 
-::: moniker range=">= vs-2022"
-## Get AI assistance
-
-If you have [Copilot](../ide/visual-studio-github-copilot-extension.md), you can get AI assistance while you're looking at variables in the Autos or Locals windows, or in data tips. Right-click on a variable and use the **Ask Copilot** ![Screenshot of Ask Copilot button.](../debugger/media/vs-2022/debug-with-copilot-ask-copilot-button.png) button. In this scenario, Copilot already knows the context for your question, so you don't need to provide context yourself in chat. For more information, see [Debug with Copilot](../debugger/debug-with-copilot.md).
-::: moniker-end
-
 ## Related content
 
 - [What is debugging?](../debugger/what-is-debugging.md)
diff --git a/docs/debugger/debug-with-copilot.md b/docs/debugger/debug-with-copilot.md
@@ -222,8 +222,8 @@ In addition, Copilot provides more precise help for some targeted scenarios, suc
 |Conditional breakpoints and tracepoints|See [Get suggestions with conditional breakpoints and tracepoints](#get-suggestions-with-conditional-breakpoints-and-tracepoints) in this article.|
 |Quick Actions (light bulb)|See [Get AI assistance with Quick Actions](../ide/quick-actions.md#get-ai-assistance).|
 |IEnumerable tabular visualizer|See [Modify the visualizer expression](../debugger/view-data-in-tabular-visualizer.md#modify-the-expression-in-the-ienumerable-visualizer).|
-|Inline return values|See [View return values of method calls](../debugger/autos-and-locals-windows.md#view-return-values-of-method-calls).|
+|Inline return values|See [View return values of method calls](../debugger/autos-and-locals-windows.md#view-inline-return-values-of-method-calls-in-the-code-editor).|
 |Summary thread descriptions|See [Threads View (Parallel Stacks)](../debugger/using-the-parallel-stacks-window.md#threads-view).|
 |Auto insights for profiling|See [Get AI assistance with Auto insights](../profiling/cpu-insights.md#get-ai-assistance).|
 
-In most of these scenarios, you get targeted assistance by using the **Ask Copilot** ![Screenshot of Ask Copilot button.](../debugger/media/vs-2022/debug-with-copilot-ask-copilot-button.png) button. Copilot already knows the context for your questions. For example, it knows the current call stack, the code line you are asking about, and the name of the exception (if one occurred), so you don't need to provide context yourself in chat. Copilot also provides suggestions for the use of conditional breakpoints and tracepoints.
+In most of these scenarios, you get targeted assistance by using the **Ask Copilot** ![Screenshot of Ask Copilot button.](../debugger/media/vs-2022/debug-with-copilot-ask-copilot-button.png) button. Copilot already knows the context for your questions. For example, it knows the current call stack, the code line you're asking about, and the name of the exception (if one occurred), so you don't need to provide context yourself in chat. Copilot also provides suggestions for the use of conditional breakpoints and tracepoints.
