Skip to content

Commit ab59471

Browse files
ghogenghogen
authored
Merge pull request #1422 from MicrosoftDocs/gewarren-options
Updates C# options dialog topics to reflect current UI
2 parents f9a8bee + a76131b commit ab59471

5 files changed

+179
-208
lines changed

‎docs/ide/reference/options-text-editor-csharp-advanced.md

Lines changed: 73 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Options, Text Editor, C#, Advanced | Microsoft Docs"
3-
ms.custom: ""
43
ms.date: "11/04/2016"
54
ms.reviewer: ""
65
ms.suite: ""
@@ -9,8 +8,6 @@ ms.tgt_pltfrm: ""
98
ms.topic: reference
109
f1_keywords:
1110
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Outlining"
12-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Advanced"
13-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Outlining"
1411
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Advanced"
1512
helpviewer_keywords:
1613
- "XML comments"
@@ -25,59 +22,88 @@ ms.workload:
2522
---
2623
# Options, Text Editor, C#, Advanced
2724

28-
Use this dialog box to modify the settings for editor formatting, code refactoring, and XML documentation comments for C#. To access this dialog box, click **Options** on the **Tools** menu, expand the **Text Editor** folder, expand **C#**, and then click **Advanced**.
25+
Use the **Advanced** options page to modify the settings for editor formatting, code refactoring, and XML documentation comments for C#. To access this options page, choose **Tools** > **Options**, and then choose **Text Editor** > **C#** > **Advanced**.
2926

3027
> [!NOTE]
3128
> The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose **Import and Export Settings** on the **Tools** menu. For more information, see [Personalize the Visual Studio IDE](../../ide/personalizing-the-visual-studio-ide.md).
3229
30+
## Analysis
31+
32+
- Enable full solution analysis
33+
34+
Enables code analysis on all files in the solution, not just open code files. For more information, see [Full solution analysis](../../code-quality/how-to-enable-and-disable-full-solution-analysis-for-managed-code.md).
35+
36+
- Perform editor feature analysis in external process (experimental)
37+
38+
## Using Directives
39+
40+
- Place 'System' directives first when sorting usings
41+
42+
- Separate using directive groups
43+
44+
- Suggest usings for types in reference assemblies
45+
46+
- Suggest usings for types in NuGet packages
47+
48+
## Highlighting
49+
50+
- Highlight references to symbol under cursor
51+
52+
When the cursor is positioned inside a symbol, or when you click a symbol, all the instances of that symbol in the code file are highlighted.
53+
54+
- Highlight related keywords under cursor
55+
3356
## Outlining
3457

35-
Enter outlining mode when files open
36-
When selected, automatically outlines the code file, which creates collapsible blocks of code. The first time a file is opened, #regions blocks and inactive code blocks collapse.
58+
- Enter outlining mode when files open
59+
60+
When selected, automatically outlines the code file, which creates collapsible blocks of code. The first time a file is opened, #regions blocks and inactive code blocks collapse.
61+
62+
- Show procedure line separators
63+
64+
- Show outlining for declaration level constructs
65+
66+
- Show outlining for code level constructs
67+
68+
- Show outlining for comments and preprocessor regions
69+
70+
- Collapse #regions when collapsing to definitions
71+
72+
## Fading
73+
74+
- Fade out unused usings
75+
76+
- Fade out unreachable code
77+
78+
## Block Structure Guides
79+
80+
- Show guides for declaration level constructs
81+
82+
- Show guides for code level constructs
3783

3884
## Editor Help
3985

40-
Underline errors in the editor
41-
Identifies build errors in code. When this option is selected, wavy underlines appear in colors that have specific meanings:
42-
43-
- Parse errors are red.
44-
45-
- Build errors are blue.
46-
47-
- Build warnings are green.
48-
49-
- Invalid [Edit and Continue](../../debugger/edit-and-continue.md) edits are purple.
50-
51-
Move the pointer over the underlined code segment to see a ToolTip with information about the error.
52-
53-
Show live semantic errors
54-
Identifies certain compile errors without explicit compilation, for example, declaring and using an unknown type or referencing an unknown property.
55-
56-
Highlight references to symbol under cursor
57-
When the cursor is positioned inside a symbol, or when you click a symbol, all the instances of that symbol in the code file are highlighted.
58-
59-
## Refactoring
60-
61-
Verify results of refactoring
62-
Displays the **Verification Results** dialog box when you try to refactor code that contains build errors, or when refactoring would cause a code reference to bind to something different from its original binding.
63-
64-
Warn on members with compiler generated references
65-
Displays a warning dialog when you try to refactor a member that has the same name as a compiler generated reference.
66-
67-
## XML Documentation Comments
68-
69-
Generate XML documentation comments for ///
70-
When selected, inserts the XML elements for XML documentation comments after you type the `///` comment introduction. For more information about XML documentation, see [XML Documentation Comments (C# Programming Guide)](/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments).
71-
72-
## Implement Interface
73-
74-
Surround generated code with #region
75-
Inserts a #region \<*interface name*> Member around the methods when Implement Interface or Implement Interface Explicitly is used.
76-
77-
## Organize Usings
78-
79-
Place 'System' directives first when sorting usings
80-
When selected, `System` using directives appear before other using directives. For more information, see Organize usings in [C# IntelliSense](../../ide/visual-csharp-intellisense.md#automatic-code-generation).
86+
- Generate XML documentation comments for ///
87+
88+
When selected, inserts the XML elements for XML documentation comments after you type the `///` comment introduction. For more information about XML documentation, see [XML Documentation Comments (C# Programming Guide)](/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments).
89+
90+
- Insert \* at the start of new lines when writing /\* \*/ comments
91+
92+
- Show preview for rename tracking
93+
94+
- Split string literals on enter
95+
96+
- Report invalid placeholders in 'string.Format' calls
97+
98+
## Extract Method
99+
100+
- Don't put ref or out on custom struct
101+
102+
## Implement Interface or Abstract Class
103+
104+
- When inserting properties, events and methods, place them with other members of the same kind, or at the end
105+
106+
- When generating properties, prefer throwing properties or prefer auto properties
81107

82108
## See also
83109

‎docs/ide/reference/options-text-editor-csharp-formatting.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,21 @@
11
---
22
title: "Options, Text Editor, C#, Formatting | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
3+
ms.date: 02/09/2018
54
ms.reviewer: ""
65
ms.suite: ""
7-
ms.technology:
8-
- "vs-ide-general"
9-
ms.tgt_pltfrm: ""
6+
ms.technology: vs-ide-general
107
ms.topic: "article"
118
f1_keywords:
129
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting.Spacing"
1310
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting.NewLines"
14-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting.General"
1511
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting.Indentation"
16-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting.NewLines"
17-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting.Indentation"
18-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting.Wrapping"
1912
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting.Wrapping"
2013
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting"
2114
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Formatting.General"
22-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting.Spacing"
23-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Formatting"
2415
helpviewer_keywords:
25-
- "formatting [C#]"
26-
- "Text Editor Options dialog box, formatting"
16+
- "formatting options [C#]"
17+
- "Text editor Options dialog box, formatting"
2718
ms.assetid: 5a7bb668-1d0c-4ffe-9508-24592813162e
28-
caps.latest.revision: 23
2919
author: "gewarren"
3020
ms.author: "gewarren"
3121
manager: ghogen
@@ -34,27 +24,33 @@ ms.workload:
3424
---
3525
# Options, Text Editor, C#, Formatting
3626

37-
Use the **Formatting** property page dialog box to set options for formatting code in the Code Editor. To access the **Options** dialog box in Visual Studio, click **Tools** > **Options**. Then, expand **Text Editor**, expand **C#**, expand **Code Style**, and then click **Formatting**.
38-
27+
Use the **Formatting** options page to set options for formatting code in the Code Editor. To access this options page, choose **Tools** > **Options**, and then choose **Text Editor** > **C#** > **Code Style** > **Formatting**.
28+
3929
> [!NOTE]
40-
> The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose **Import and Export Settings** on the **Tools** menu. For more information, see [Personalize the Visual Studio IDE](../../ide/personalizing-the-visual-studio-ide.md).
41-
42-
## General Settings
43-
The general settings affect how the Code Editor applies formatting options to code.
44-
45-
## UIElement List
46-
47-
|Label|Description|
48-
|-----------|-----------------|
49-
|**Automatically format completed statement on ;**|When selected, formats statements at completion according to the formatting options selected for the Code Editor. Clear this box if you do not want the Code Editor to alter statements.|
50-
|**Automatically format completed block on }**|When selected, formats code blocks according to the formatting options selected for the Code Editor as soon as you complete the code block. Clear this box if you do not want the Code Editor to alter blocks.|
51-
|**Adjust indentation on paste**|When selected, formats text pasted into the Code Editor to fit the formatting options selected for the Code Editor. Clear this box if you do not want pasted text to be altered.|
52-
53-
## Preview Window
54-
The **Indentation**, **New Lines**, **Spacing**, and **Wrapping** options panes each display a preview window. The preview window shows the effect of each option. To use the preview window, select a formatting option. The preview window shows an example of the selected option. When you change the setting, for example, when you select or clear a check box, the preview window updates to show the effect of the new setting.
55-
56-
## Remarks
57-
Indentation options on the **Tabs** pages for each language only determine where the Code Editor places the cursor when you press ENTER at the end of a line. Indentation options under **Formatting** apply when code is formatted automatically, for example, when you paste code into the file while **Adjust indentation on paste** is selected, and when the block being formatted is typed manually.
58-
59-
## See Also
60-
[General, Environment, Options Dialog Box](../../ide/reference/general-environment-options-dialog-box.md)
30+
> The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose **Import and Export Settings** on the **Tools** menu. For more information, see [Personalize the Visual Studio IDE](../../ide/personalizing-the-visual-studio-ide.md).
31+
32+
## General settings
33+
34+
The General settings affect how the Code Editor applies formatting options to code.
35+
36+
## UIElement list
37+
38+
|Label|Description|
39+
|-----------|-----------------|
40+
|**Automatically format when typing**|When deselected, the **format statement on ;** and **format block on }** options are disabled.|
41+
|**Automatically format statement on ;**|When selected, formats statements at completion according to the formatting options selected for the editor.|
42+
|**Automatically format block on }**|When selected, formats code blocks according to the formatting options selected for the editor as soon as you complete the code block.|
43+
|**Automatically format on return**|When selected, formats text when **Enter** is pressed, to fit the formatting options selected for the editor.|
44+
|**Automatically format on paste**|When selected, formats text that is pasted into the editor to fit the formatting options selected for the editor.|
45+
46+
## Preview window
47+
48+
The **Indentation**, **New Lines**, **Spacing**, and **Wrapping** options panes each display a preview window. The preview window shows the effect of each option. To use the preview window, select a formatting option. The preview window shows an example of the selected option. When you change a setting by selecting a radio button or check box, the preview window updates to show the effect of the new setting.
49+
50+
## Remarks
51+
52+
Indentation options on the **Tabs** pages for each language only determine where the Code Editor places the cursor when you press **Enter** at the end of a line. Indentation options under **Formatting** apply when code is formatted automatically, for example, when you paste code into the file while **Automatically format on paste** is selected, and when the block being formatted is typed manually.
53+
54+
## See also
55+
56+
[General, Environment, Options Dialog Box](../../ide/reference/general-environment-options-dialog-box.md)

‎docs/ide/reference/options-text-editor-csharp-intellisense.md

Lines changed: 64 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,87 @@
11
---
22
title: "Options, Text Editor, C#, IntelliSense | Microsoft Docs"
3-
ms.custom: ""
43
ms.date: "11/04/2016"
54
ms.reviewer: ""
65
ms.suite: ""
7-
ms.technology:
8-
- "vs-ide-general"
9-
ms.tgt_pltfrm: ""
6+
ms.technology: vs-ide-general
107
ms.topic: "article"
118
f1_keywords:
129
- "VS.ToolsOptionsPages.Text_Editor.CSharp.Intellisense"
13-
- "VS.ToolsOptionsPages.Text_Editor.Visual_JSharp.Intellisense"
1410
helpviewer_keywords:
1511
- "underlines, wavy"
1612
- "IntelliSense [C#], options"
1713
- "IntelliSense [C#], wavy underlines"
1814
- "wavy underlines"
1915
- "Text Editor Options dialog box, IntelliSense"
2016
ms.assetid: 3466dedb-e5f4-424c-8dd8-e4941b2f4fc2
21-
caps.latest.revision: 25
2217
author: "gewarren"
2318
ms.author: "gewarren"
2419
manager: ghogen
2520
ms.workload:
2621
- "dotnet"
2722
---
2823
# Options, Text Editor, C#, IntelliSense
29-
Use the **IntelliSense** property page to modify settings that affect the behavior of IntelliSense for C#. You can access the **IntelliSense** property page by clicking **Options** on the **Tools** menu, then clicking **C#** in the **Text Editor** folder, and then clicking **IntelliSense.**
30-
24+
25+
Use the **IntelliSense** options page to modify settings that affect the behavior of IntelliSense for C#. To access this options page, choose **Tools** > **Options**, and then choose **Text Editor** > **C#** > **IntelliSense**.
26+
3127
> [!NOTE]
32-
> The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose **Import and Export Settings** on the **Tools** menu. For more information, see [Personalize the Visual Studio IDE](../../ide/personalizing-the-visual-studio-ide.md).
33-
34-
The **IntelliSense** property page contains the following properties:
35-
36-
## Completion Lists
37-
**Show completion list after a character is typed**
38-
When this option is selected, IntelliSense automatically displays the completion list when you begin typing. When this option is not selected, IntelliSense completion is still available from the **IntelliSense** menu or by pressing CTRL+SPACE.
39-
40-
**Place keywords in completion lists**
41-
When this option is selected, IntelliSense adds C# keywords, for example, [class](/dotnet/csharp/language-reference/keywords/class), to the completion list.
42-
43-
**Place code snippets in completion lists**
44-
When this option is selected, IntelliSense adds aliases for C# code snippets to the completion list. In the case where the code snippet alias is the same as a keyword, for example, [class](/dotnet/csharp/language-reference/keywords/class), the keyword is replaced by the shortcut. For more information, see [C# Code Snippets](../../ide/visual-csharp-code-snippets.md).
45-
46-
## Selection in Completion Lists
47-
**Committed by typing the following characters:**
48-
Specifies all characters that execute IntelliSense automatic completion for the selected item in completion list, after they are typed.
49-
50-
**Committed by pressing the space bar**
51-
Specifies to include the action of pressing the space bar to execute IntelliSense automatic completion for the selected item in completion list.
52-
53-
**Add new line on enter at end of fully typed word**
54-
Specifies that if you type all the characters for an entry in the completion list and then press ENTER, a new line is created automatically and the cursor moves to the new line.
55-
56-
For example, if you type `else` and then press ENTER, the following appears in the editor:
57-
58-
`else`
59-
60-
`|` (cursor location)
61-
62-
However, if you type only `el` and then press ENTER, the following appears in the editor:
63-
64-
`else|` (cursor location)
65-
66-
## IntelliSense Member Selection
67-
**Pre-selects most recently used member**
68-
When this option is selected, IntelliSense pre-selects the members that you have recently selected in the pop-up List Members box for automatic object name completion, during your current session in the integrated development environment (IDE). The history of most recently used members is cleared between each session in the IDE. For more information, see [IntelliSense for Most Recently Used Members](../../ide/visual-csharp-intellisense.md#most-recently-used-members).
69-
70-
## See Also
71-
[General, Environment, Options Dialog Box](../../ide/reference/general-environment-options-dialog-box.md)
72-
[XML Documentation Comments](/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments)
73-
[Using IntelliSense](../../ide/using-intellisense.md)
28+
> The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose **Import and Export Settings** on the **Tools** menu. For more information, see [Personalize the Visual Studio IDE](../../ide/personalizing-the-visual-studio-ide.md).
29+
30+
The **IntelliSense** options page contains the following options:
31+
32+
## Completion Lists
33+
34+
- Show completion list after a character is typed*
35+
36+
When this option is selected, IntelliSense automatically displays the completion list when you begin typing. When this option is not selected, IntelliSense completion is still available from the **IntelliSense** menu or by pressing **Ctrl**+**Space**.
37+
38+
- Show completion list after a character is deleted
39+
40+
- Highlight matching portions of completion list items
41+
42+
- Show completion list filters
43+
44+
- Show name suggestions
45+
46+
### Snippets behavior
47+
48+
- Never include snippets
49+
50+
When this option is selected, IntelliSense never adds aliases for C# code snippets to the completion list.
51+
52+
- Always include snippets
53+
54+
When this option is selected, IntelliSense adds aliases for C# code snippets to the completion list. In the case where the code snippet alias is the same as a keyword, for example, [class](/dotnet/csharp/language-reference/keywords/class), the keyword is replaced by the shortcut. For more information, see [C# Code Snippets](../../ide/visual-csharp-code-snippets.md).
55+
56+
- Include snippets when ?-Tab is typed after an identifier
57+
58+
When this option is selected, IntelliSense adds aliases for C# code snippets to the completion list when **?**+**Tab** is pressed after an identifier
59+
60+
### Enter key behavior
61+
62+
- Never add new line on enter
63+
64+
Specifies that a new line is never added automatically after selecting an item in the completion list and pressing **Enter**.
65+
66+
- Only add new line on enter after end of fully typed word
67+
68+
Specifies that if you type all the characters for an entry in the completion list and then press **Enter**, a new line is added automatically and the cursor moves to the new line.
69+
70+
For example, if you type `else` and then press **Enter**, the following appears in the editor:
71+
72+
`else`
73+
74+
`|` (cursor location)
75+
76+
However, if you type only `el` and then press **Enter**, the following appears in the editor:
77+
78+
`else|` (cursor location)
79+
80+
- Always add new line on enter
81+
82+
Specifies that if you type *any* of the characters for an entry in the completion list and then press **Enter**, a new line is added automatically and the cursor moves to the new line.
83+
84+
## See also
85+
86+
[General, Environment, Options Dialog Box](../../ide/reference/general-environment-options-dialog-box.md)
87+
[Using IntelliSense](../../ide/using-intellisense.md)

0 commit comments

Comments
 (0)