Skip to content

Commit d080ffd

Browse files
authored
Merge pull request #3375 from Mikejo5000/mikejo-exp2
Overview docs - TOC fix, review feedback
2 parents 528b4b2 + ab3a7ae commit d080ffd

8 files changed

+21
-20
lines changed

docs/debugger/autos-and-locals-windows.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,14 @@ ms.workload:
1919
---
2020
# Inspect variables in the Autos and Locals windows
2121

22-
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 breakpoint. The **Locals** window shows variables defined in the local scope, which is usually the current function or method. If this is the first time that you've tried to debug code, you may want to read [Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
22+
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 breakpoint. The **Locals** window shows variables defined in the local scope, which is usually the current function or method. If this is the first time that you've tried to debug code, you may want to read [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
2323

2424
The **Autos** window is available for C#, Visual Basic, C++, and Python code, but not for JavaScript or F#.
2525

2626
To open the **Autos** window, while debugging, select **Debug** > **Windows** > **Autos**, or press **Ctrl**+**Alt**+**V** > **A**.
2727

2828
To open the **Locals** window, while debugging, select **Debug** > **Windows** > **Locals**, or press **Alt**+**4**.
2929

30-
If you need more information about basic debugging, see [Getting started with the Debugger](../debugger/getting-started-with-the-debugger.md).
31-
3230
> [!NOTE]
3331
> This topic applies to Visual Studio on Windows. For Visual Studio for Mac, see [Data visualizations in Visual Studio for Mac](/visualstudio/mac/data-visualizations).
3432
@@ -147,6 +145,6 @@ To see the return values of the `sumVars()` and `subtractVars()` method calls in
147145

148146
## See also
149147
[What is debugging?](../debugger/what-is-debugging.md)
150-
[Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md)
148+
[Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md)
151149
[First look at debugging](../debugger/debugger-feature-tour.md)
152150
[Debugger windows](../debugger/debugger-windows.md)

docs/debugger/getting-started-with-the-debugger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ms.workload:
1919
---
2020
# Tutorial: Learn to debug using Visual Studio
2121

22-
This article introduces the features of the Visual Studio debugger in a step-by-step walkthrough. If you want a higher-level view of the debugger features, see [Debugger Feature Tour](../debugger/debugger-feature-tour.md). When you *debug your app*, it usually means that you are running your application with the debugger attached. When you do this, the debugger provides many ways to see what your code is doing while it runs. You can step through your code and look at the values stored in variables, you can set watches on variables to see when values change, you can examine the execution path of your code, see whether a branch of code is running, and so on. If this is the first time that you've tried to debug code, you may want to read [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
22+
This article introduces the features of the Visual Studio debugger in a step-by-step walkthrough. When you *debug your app*, it usually means that you are running your application with the debugger attached. When you do this, the debugger provides many ways to see what your code is doing while it runs. You can step through your code and look at the values stored in variables, you can set watches on variables to see when values change, you can examine the execution path of your code, see whether a branch of code is running, and so on. If this is the first time that you've tried to debug code, you may want to read [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) and [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md) before going through this article.
2323

2424
| | |
2525
|---------|---------|

docs/debugger/navigating-through-code-with-the-debugger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ms.workload:
1919
---
2020
# Navigate through code with the Visual Studio debugger
2121

22-
The Visual Studio debugger can help you navigate through code to inspect the state of an app and show its execution flow. You can use keyboard shortcuts, debug commands, breakpoints, and other features to quickly get to the code you want to examine. Familiarity with debugger navigation commands and shortcuts makes it faster and easier to find and resolve app issues. If this is the first time that you've tried to debug code, you may want to read [Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
22+
The Visual Studio debugger can help you navigate through code to inspect the state of an app and show its execution flow. You can use keyboard shortcuts, debug commands, breakpoints, and other features to quickly get to the code you want to examine. Familiarity with debugger navigation commands and shortcuts makes it faster and easier to find and resolve app issues. If this is the first time that you've tried to debug code, you may want to read [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
2323

2424
## Basic debugging
2525

@@ -181,5 +181,5 @@ To load Microsoft symbols, see [Configure symbol locations and loading options](
181181

182182
## See also
183183
[What is debugging?](../debugger/what-is-debugging.md)
184-
[Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md)
184+
[Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md)
185185
[First look at debugging](../debugger/debugger-feature-tour.md)

docs/debugger/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
items:
55
- name: "What is debugging?"
66
href: what-is-debugging.md
7-
- name: "Write better C# code with Visual Studio"
7+
- name: Fix bugs by writing better C# code
88
href: write-better-code-with-visual-studio.md
99
- name: Quickstarts
1010
items:

docs/debugger/view-data-values-in-data-tips-in-the-code-editor.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ms.workload:
2222
---
2323
# View data values in DataTips in the code editor
2424

25-
DataTips are a convenient way to view information about variables in your app during debugging.
25+
DataTips provide a convenient way to view information about variables in your program during debugging. DataTips work only in break mode and only with variables that are in the current scope of execution. If this is the first time that you've tried to debug code, you may want to read [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
2626

2727
If this is your first time debugging, you may want to read [Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before you read this article.
2828

@@ -121,8 +121,9 @@ You can export DataTips to an XML file, which you can share or edit using a text
121121

122122
## See also
123123
[What is debugging?](../debugger/what-is-debugging.md)
124-
[Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md)
125-
[First look at debugging](../debugger/debugger-feature-tour.md)
126-
[View data in the debugger](../debugger/viewing-data-in-the-debugger.md)
127-
[Watch and QuickWatch windows](../debugger/watch-and-quickwatch-windows.md)
128-
[Create custom visualizers](../debugger/create-custom-visualizers-of-data.md)
124+
[Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md)
125+
[First look at debugging](../debugger/debugger-feature-tour.md)
126+
[Viewing Data in the Debugger](../debugger/viewing-data-in-the-debugger.md)
127+
[Watch and QuickWatch Windows](../debugger/watch-and-quickwatch-windows.md)
128+
[Create Custom Visualizers](../debugger/create-custom-visualizers-of-data.md)
129+

docs/debugger/watch-and-quickwatch-windows.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ While you're debugging, you can use **Watch** windows and **QuickWatch** to watc
2525

2626
**Watch** windows can display several variables at a time while debugging. The **QuickWatch** dialog displays a single variable at a time, and must be closed before debugging can continue.
2727

28+
If this is the first time that you've tried to debug code, you may want to read [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md) and [Debugging for absolute beginners](../debugger/debugging-absolute-beginners.md) before going through this article.
29+
2830
## Observe variables with a Watch window
2931

3032
You can open more than one **Watch** window, and observe more than one variable in a **Watch** window.
@@ -273,6 +275,6 @@ To observe the `a` variable,
273275

274276
## See also
275277
[What is debugging?](../debugger/what-is-debugging.md)
276-
[Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md)
278+
[Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md)
277279
[First look at debugging](../debugger/debugger-feature-tour.md)
278280
[Debugger windows](../debugger/debugger-windows.md)

docs/debugger/what-is-debugging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ The Visual Studio debugger is a powerful tool. Before we show how to use it, we
1919

2020
## Debugger vs. debugging
2121

22-
The term *debugging* is pretty general, and can mean a lot of different things. In the most literal usage of the word, it means removing bugs from your code. Now, there are a lot of ways to do this. For example, you might debug by scanning your code looking for typos, or by using a code analyzer. You might debug code by using a performance profiler. Or, you might debug by using a *debugger*.
22+
The term *debugging* can mean a lot of different things, but most literally, it means removing bus from your code. Now, there are a lot of ways to do this. For example, you might debug by scanning your code looking for typos, or by using a code analyzer. You might debug code by using a performance profiler. Or, you might debug by using a *debugger*.
2323

24-
A debugger is a very specialized developer tool. A debugger attaches to your running app and allows you to inspect your code. In the debugging documentation for Visual Studio, this is typically what we mean when we say "debugging".
24+
A debugger is a very specialized developer tool that attaches to your running app and allows you to inspect your code. In the debugging documentation for Visual Studio, this is typically what we mean when we say "debugging".
2525

2626
## Debug mode vs. running your app
2727

28-
When you run your app in Visual Studio for the first time, you may start it by pressing the green arrow button ![Start Debugging](../debugger/media/dbg-tour-start-debugging.png "Start Debugging") in the toolbar. By default, the **Debug** value appears in the drop-down to the left. If you are new to Visual Studio, this can leave the impression that debugging your app has something to do with running your app--which it does--but these are fundamentally two very different tasks.
28+
When you run your app in Visual Studio for the first time, you may start it by pressing the green arrow button ![Start Debugging](../debugger/media/dbg-tour-start-debugging.png "Start Debugging") in the toolbar (or **F5**). By default, the **Debug** value appears in the drop-down to the left. If you are new to Visual Studio, this can leave the impression that debugging your app has something to do with running your app--which it does--but these are fundamentally two very different tasks.
2929

3030
![Select a Debug build](../debugger/media/what-is-debugging-debug-build.png)
3131

@@ -46,4 +46,4 @@ The debugger is an essential tool to find and fix bugs in your apps. However, co
4646
In this article, you've learned a few general debugging concepts. Next, you can start learning how to debug with Visual Studio and how to write code with less bugs. The following article shows C# code examples, but the concepts apply to all languages supported by Visual Studio.
4747

4848
> [!div class="nextstepaction"]
49-
> [Write better C# code using Visual Studio](../debugger/write-better-code-with-visual-studio.md)
49+
> [Fix bugs by writing better C# code](../debugger/write-better-code-with-visual-studio.md)

docs/debugger/write-better-code-with-visual-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload:
1515
---
1616
# Fix bugs by writing better C# code using Visual Studio
1717

18-
Debugging code can be a time-consuming--and sometimes frustrating--task. It takes time to learn how to debug effectively. A powerful IDE like Visual Studio can make your job a lot easier. An IDE can help you debug your code more quickly, and not just that, but it can also help you write better code with fewer bugs. Our aim in this article is to give you a holistic view of the debugging process, so you will know when to use the code analyzer, when to use the debugger, and when to use other tools.
18+
Debugging code can be a time-consuming--and sometimes frustrating--task. It takes time to learn how to debug effectively, but a powerful IDE like Visual Studio can make your job a lot easier. An IDE can help you debug your code more quickly, and not just that, but it can also help you write better code with fewer bugs. Our aim in this article is to give you a holistic view of the debugging process, so you will know when to use the code analyzer, when to use the debugger, and when to use other tools.
1919

2020
In this article, we talk about leveraging the IDE to make your debugging sessions more productive. We touch on several tasks, such as:
2121

0 commit comments

Comments
 (0)