Merge pull request #3371 from v-thepet/code-map

Refresh code map article

Author: rjagiewich

docs/debugger/map-methods-on-the-call-stack-while-debugging-in-visual-studio.md

@@ -1,7 +1,7 @@
 ---
 title: "Create a visual map of the call stack | Microsoft Docs"
 ms.custom: ""
-ms.date: "05/18/2017"
+ms.date: "11/26/2018"
 ms.technology: "vs-ide-debug"
 ms.topic: "conceptual"
 f1_keywords:
@@ -32,160 +32,131 @@ manager: douge
 ms.workload:
   - "multiple"
 ---
-# Create a visual map of the call stack while debugging in Visual Studio Enterprise
-Create a code map to visually trace the call stack while you're debugging. You can make notes on the map to track what the code is doing so you can focus on finding bugs.
+# Create a visual map of the call stack while debugging 
 
- You'll need:
+Create a code map to visually trace the call stack while you're debugging. You can make notes on the map to track what the code is doing, so you can focus on finding bugs.
 
--   [Visual Studio Enterprise](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=button+cta&utm_content=download+vs2017)
+For a walkthrough, watch this video: 
+[Video: Debug visually with Code Map debugger integration (Channel 9)](http://go.microsoft.com/fwlink/?LinkId=293418)
 
--   Code that you can debug, such as Visual C#, Visual Basic, C++, JavaScript, or X++
+For details of commands and actions you can use with code maps, see [Browse and rearrange code maps](../modeling/browse-and-rearrange-code-maps.md).
+
+>[!IMPORTANT]
+>You can create code maps only in [Visual Studio Enterprise edition](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=button+cta&utm_content=download+vs2017).
 
 Here's a quick look at a code map:
 
  ![Debugging with call stacks on code maps](../debugger/media/debuggermap_overview.png "DebuggerMap_Overview")
 
- See:
-
-- [Video: Debug visually with Code Map debugger integration (Channel 9)](http://go.microsoft.com/fwlink/?LinkId=293418)
+##  <a name="MapStack"></a> Map the call stack
 
-- [Map the call stack](#MapStack)
+1. In a Visual Studio Enterprise C#, Visual Basic, C++, JavaScript, or X++ project, start debugging by selecting **Debug** > **Start Debugging** or pressing **F5**.
+   
+1. After your app enters break mode or you step into a function, select **Debug** > **Code Map**, or press **Ctrl**+**Shift**+**`**.
 
-- [Make notes about the code](#MakeNotes)
+   The current call stack appears in orange on a new code map:
 
-- [Update the map with the next call stack](#UpdateMap)
+   ![See call stack on code map](../debugger/media/debuggermap_seeundocallstack.png "DebuggerMap_SeeUndoCallStack")
 
-- [Add related code to the map](#AddRelatedCode)
+The code map updates automatically as you continue debugging. Changing map items or layout doesn't affect the code in any way. Feel free to rename, move, or remove anything on the map.
 
-- [Find bugs using the map](#FindBugs)
+To get more information about an item, hover over it and look at the item's tooltip. You can also select **Legend** in the toolbar to learn what each icon means.
 
-- [Q & A](#QA)
+![Code Map Legend](../debugger/media/debuggermap_showlegend.png "Code Map Legend")
 
-  For details of the commands and actions you can use when working with code maps, see [Browse and rearrange code maps](../modeling/browse-and-rearrange-code-maps.md).
+>[!NOTE]
+>The message **The diagram may be based on an older version of the code** at the top of the code map means that the code might have changed after you last updated the map. For example, a call on the map might not exist in code anymore. Close the message, then try rebuilding the solution before updating the map again.
 
-##  <a name="MapStack"></a> Map the call stack
+## Map external code
 
-1.  Start debugging. (Keyboard: **F5**)
+By default, only your own code appears on the map. To see external code on the map:
+  
+- Right-click in the **Call Stack** window and select **Show External Code**:
+  
+  ![Display external code using the Call Stack window](../debugger/media/debuggermap_callstackmenu.png "DebuggerMap_CallStackMenu")
+- Or, deselect **Enable Just My Code** in Visual Studio **Tools** (or **Debug**) > **Options** > **Debugging**:
+  
+  ![Show external code using Options dialog](../debugger/media/debuggermap_debugoptions.png "DebuggerMap_DebugOptions")
 
-2.  After your app enters break mode or you step into a function, choose **Code Map**. (Keyboard: **Ctrl** + **Shift** + **`**)
+## Control the map's layout
 
-     ![Choose Code Map to start mapping call stack](../debugger/media/debuggermap_choosecodemap.png "DebuggerMap_ChooseCodeMap")
+Changing the map's layout doesn't affect the code in any way. 
 
-     The current call stack appears in orange on a new code map:
+To control the map's layout, select the **Layout** menu on the map toolbar. 
 
-     ![See call stack on code map](../debugger/media/debuggermap_seeundocallstack.png "DebuggerMap_SeeUndoCallStack")
+In the **Layout** menu, you can:
 
-     The map will update automatically while you continue debugging. See [Update the map with the next call stack](#UpdateMap).
+-   Change the default layout.
+-   Stop rearranging the map automatically, by deselecting **Automatically Layout when Debugging**.
+-   Rearrange the map as little as possible when you add items, by deselecting **Incremental Layout**.
 
 ##  <a name="MakeNotes"></a> Make notes about the code
- Add comments to track what's happening in the code. To add a new line in a comment, press **Shift + Return**.
+
+You can add comments to track what's happening in the code. 
+
+To add a comment, right-click in the code map and select **Edit** > **New Comment**, then type the comment. 
+
+To add a new line in a comment, press **Shift**+**Enter**.
 
  ![Add comment to call stack on code map](../debugger/media/debuggermap_addcomment.png "DebuggerMap_AddComment")
 
 ##  <a name="UpdateMap"></a> Update the map with the next call stack
- Run your app to the next breakpoint or step into a function. The map adds a new call stack.
 
- ![Update code map with next call stack](../debugger/media/debuggermap_addclearcallstack.png "DebuggerMap_AddClearCallStack")
+As you run your app to the next breakpoint or step into a function, the map adds new call stacks automatically.
+
+![Update code map with next call stack](../debugger/media/debuggermap_addclearcallstack.png "DebuggerMap_AddClearCallStack")
+
+To stop the map from adding new call stacks automatically, select ![Show call stack on code map automatically](../debugger/media/debuggermap_automaticupdateicon.gif "Show call stack on code map automatically") on the code map toolbar. The map continues to highlight existing call stacks. To manually add the current call stack to the map, press **Ctrl**+**Shift**+**`**. 
 
 ##  <a name="AddRelatedCode"></a> Add related code to the map
- Now you've got a map - what next? If you're working with Visual C# or Visual Basic, add items, such as fields, properties, and other methods, to track what's happening in the code.
 
- Double-click a method to see its code definition, or use the shortcut menu for the method. (Keyboard: Select the method on the map and press **F12**)
+Now that you've got a map, in C# or Visual Basic, you can add items like fields, properties, and other methods, to track what's happening in the code. 
 
- ![Go to code definition for a method on code map](../debugger/media/debuggermap_gotocodedefinition.png "DebuggerMap_GoToCodeDefinition")
+To go to the definition of a method in the code, double-click the method in the map, or select it and press **F12**, or right-click it and select **Go To Definition**.
 
- Add the items that you want to track on the map.
+![Go to code definition for a method on code map](../debugger/media/debuggermap_gotocodedefinition.png "DebuggerMap_GoToCodeDefinition")
 
- ![Show fields in a method on call stack code map](../debugger/media/debuggermap_showfields.png "DebuggerMap_ShowFields")
+To add items that you want to track to the map, right-click a method and select the items you want to track. The most recently added items appear in green.
 
-> [!NOTE]
->  By default, adding items to the map also adds the parent group nodes such as the class, namespace, and assembly. While this is useful, you can keep the map simple by turning off this feature using the **Include Parents** button on the map toolbar, or by pressing **CTRL** when you add items.
+![Fields related to a method on call stack code map](../debugger/media/debuggermap_showedfields.png "DebuggerMap_ShowedFields")
 
- ![Fields related to a method on call stack code map](../debugger/media/debuggermap_showedfields.png "DebuggerMap_ShowedFields")
+>[!NOTE]
+>By default, adding items to the map also adds the parent group nodes such as the class, namespace, and assembly. You can turn this feature off and on by selecting the **Include Parents** button on the code map toolbar, or by pressing **Ctrl** while you add items.
 
- Here you can easily see which methods use the same fields. The most recently added items appear in green.
+![Show fields in a method on call stack code map](../debugger/media/debuggermap_showfields.png "DebuggerMap_ShowFields")
 
- Continue building the map to see more code.
+Continue building the map to see more code.
 
  ![See methods that use a field: call stack code map](../debugger/media/debuggermap_findallreferences.png "DebuggerMap_FindAllReferences")
 
  ![Methods that use a field on call stack code map](../debugger/media/debuggermap_foundallreferences.png "DebuggerMap_FoundAllReferences")
 
 ##  <a name="FindBugs"></a> Find bugs using the map
- Visualizing your code can help you find bugs faster. For example, suppose you're investigating a bug in a drawing program. When you draw a line and try to undo it, nothing happens until you draw another line.
+ Visualizing your code can help you find bugs faster. For example, suppose you're investigating a bug in a drawing app. When you draw a line and try to undo it, nothing happens until you draw another line.
 
  So you set breakpoints in the `clear`, `undo`, and `Repaint` methods, start debugging, and build a map like this one:
 
  ![Add another call stack to code map](../debugger/media/debuggermap_addpaintobjectcallstack.png "DebuggerMap_AddPaintObjectCallStack")
 
  You notice that all the user gestures on the map call `Repaint`, except for `undo`. This might explain why `undo` doesn't work immediately.
 
- After you fix the bug and continue running the program, the map adds the new call from `undo` to `Repaint`:
+ After you fix the bug and continue running the app, the map adds the new call from `undo` to `Repaint`:
 
  ![Add new method call to call stack on code map](../debugger/media/debuggermap_addnewcallforrepaint.png "DebuggerMap_AddNewCallForRepaint")
 
-##  <a name="QA"></a> Q & A
-
-- **Not all calls appear on the map. Why?**
-
-   By default, only your own code appears on the map. To see external code, turn it on in the **Call Stack** window:
-
-   ![Display external code using the Call Stack window](../debugger/media/debuggermap_callstackmenu.png "DebuggerMap_CallStackMenu")
-
-   or turn off **Enable Just My Code** in the Visual Studio debugging options:
-
-   ![Show external code using Options dialog](../debugger/media/debuggermap_debugoptions.png "DebuggerMap_DebugOptions")
-
-- **Does changing the map affect the code?**
-
-   Changing the map doesn't affect the code in any way. Feel free to rename, move, or remove anything on the map.
-
-- **What does this message mean: "The diagram may be based on an older version of the code"?**
-
-   The code might have changed after you last updated the map. For example, a call on the map might not exist in code anymore. Close the message, then try rebuilding the solution before updating the map again.
-
-- **How do I control the map's layout?**
-
-   Open the **Layout** menu on the map toolbar:
-
-  -   Change the default layout.
-
-  -   To stop rearranging the map automatically, turn off **Automatically Layout when Debugging**.
-
-  -   To rearrange the map as little as possible when you add items, turn off **Incremental Layout**.
-
-- **Can I share the map with others?**
-
-   You can export the map, send it to others if you have Microsoft Outlook, or save it to your solution so you can check it into Team Foundation version control.
-
-   ![Share call stack code map with others](../debugger/media/debuggermap_sharewithothers.png "DebuggerMap_ShareWithOthers")
-
-- **How do I stop the map from adding new call stacks automatically?**
-
-   Choose ![Button &#45; Show call stack on code map automatically](../debugger/media/debuggermap_automaticupdateicon.gif "DebuggerMap_AutomaticUpdateIcon") on the map toolbar. To manually add the current call stack to the map, press **Ctrl** + **Shift** + **`**.
-
-   The map will continue highlighting existing call stacks on the map while you're debugging.
-
-- **What do the item icons and arrows mean?**
-
-   To get more info about an item, move the mouse pointer over it and look at the item's tooltip. You can also look at the **Legend** to learn what each icon means.
-
-   ![What do icons on the call stack code map mean?](../debugger/media/debuggermap_showlegend.png "DebuggerMap_ShowLegend")
+## Share the map with others
 
-  See:
+You can export a map, send it to others with Microsoft Outlook, save it to your solution, and check it into version control.
 
-- [Map the call stack](#MapStack)
+To share or save the map, use **Share** in the code map toolbar. 
 
-- [Make notes about the code](#MakeNotes)
+![Share call stack code map with others](../debugger/media/debuggermap_sharewithothers.png "Share call stack code map with others")
 
-- [Update the map with the next call stack](#UpdateMap)
+## See also
+[Map dependencies across your solutions](../modeling/map-dependencies-across-your-solutions.md)
 
-- [Add related code to the map](#AddRelatedCode)
+[Use code maps to debug your applications](../modeling/use-code-maps-to-debug-your-applications.md)
 
-- [Find bugs using the map](#FindBugs)
+[Find potential problems using code map analyzers](../modeling/find-potential-problems-using-code-map-analyzers.md)
 
-## See Also
- [Map dependencies across your solutions](../modeling/map-dependencies-across-your-solutions.md)
- [Use code maps to debug your applications](../modeling/use-code-maps-to-debug-your-applications.md)
- [Find potential problems using code map analyzers](../modeling/find-potential-problems-using-code-map-analyzers.md)
- [Browse and rearrange code maps](../modeling/browse-and-rearrange-code-maps.md)
+[Browse and rearrange code maps](../modeling/browse-and-rearrange-code-maps.md)