Merge pull request #4514 from gewarren/code-cleanup

Rework Code Cleanup sections

Author: itechedit

.openpublishing.redirection.json

@@ -1280,6 +1280,11 @@
             "redirect_url": "/visualstudio/ide/class-designer/designing-and-viewing-classes-and-types",
             "redirect_document_id": false
         },
+        {
+            "source_path": "docs/ide/code-styles-and-quick-actions.md",
+            "redirect_url": "/visualstudio/ide/code-styles-and-code-cleanup",
+            "redirect_document_id": false
+        },
         {
             "source_path": "docs/ide/command-line-arguments-for-the-help-content-manager.md",
             "redirect_url": "/visualstudio/help-viewer/command-line-arguments",

docs/code-quality/analyzers-faq.md

@@ -18,7 +18,7 @@ This page contains answers to some frequently asked questions about Roslyn analy
 
 **Q**: Should I use Roslyn analyzers or .editorconfig for code style?
 
-**A**: Roslyn analyzers and .editorconfig files work hand-in-hand. When you define code styles [in an .editorconfig file](../ide/editorconfig-code-style-settings-reference.md) or on the [text editor Options](../ide/code-styles-and-quick-actions.md) page, you're actually configuring the Roslyn analyzers that are built into Visual Studio. EditorConfig files can also be used to configure some third-party analyzer packages, such as [FxCop analyzers](configure-fxcop-analyzers.md).
+**A**: Roslyn analyzers and .editorconfig files work hand-in-hand. When you define code styles [in an .editorconfig file](../ide/editorconfig-code-style-settings-reference.md) or on the [text editor Options](../ide/code-styles-and-code-cleanup.md) page, you're actually configuring the Roslyn analyzers that are built into Visual Studio. EditorConfig files can also be used to configure some third-party analyzer packages, such as [FxCop analyzers](configure-fxcop-analyzers.md).
 
 ## EditorConfig versus rule sets
 

docs/code-quality/roslyn-analyzers-overview.md

@@ -14,7 +14,7 @@ ms.workload:
 ---
 # Overview of .NET Compiler Platform analyzers
 
-.NET Compiler Platform ("Roslyn") analyzers analyze your code for style, quality and maintainability, design, and other issues. Visual Studio includes a built-in set of analyzers that analyze your C# or Visual Basic code as you type. You configure preferences for these built-in analyzers on the [text editor Options](../ide/code-styles-and-quick-actions.md) page or in an [.editorconfig file](../ide/editorconfig-code-style-settings-reference.md). You can install additional analyzers as a Visual Studio extension or a NuGet package.
+.NET Compiler Platform ("Roslyn") analyzers analyze your code for style, quality and maintainability, design, and other issues. Visual Studio includes a built-in set of analyzers that analyze your C# or Visual Basic code as you type. You configure preferences for these built-in analyzers on the [text editor Options](../ide/code-styles-and-code-cleanup.md) page or in an [.editorconfig file](../ide/editorconfig-code-style-settings-reference.md). You can install additional analyzers as a Visual Studio extension or a NuGet package.
 
 If rule violations are found by an analyzer, they are reported in the code editor (as a *squiggly* under the offending code) and in the **Error List** window.
 

docs/ide/code-styles-and-code-cleanup.md

@@ -0,0 +1,99 @@
+---
+title: Code style options and code cleanup
+ms.date: 04/25/2019
+ms.topic: conceptual
+author: gewarren
+ms.author: gewarren
+manager: jillfra
+f1_keywords:
+  - "VS.ToolsOptionsPages.Text_Editor.CSharp.Code_Style.General"
+  - "VS.ToolsOptionsPages.Text_Editor.Basic.Code_Style.General"
+ms.workload:
+  - "multiple"
+---
+# Code style preferences
+
+You can define code style settings per-project by using an [EditorConfig file](#code-styles-in-editorconfig-files), or for all code you edit in Visual Studio on the text editor [**Options** page](#code-styles-in-the-options-dialog-box). For C# code, you can also configure Visual Studio to apply these code style preferences using the **Code Cleanup** (Visual Studio 2019) and **Format Document** (Visual Studio 2017) commands.
+
+> [!NOTE]
+> This topic applies to Visual Studio on Windows. For Visual Studio for Mac, see [Editor behavior in Visual Studio for Mac](/visualstudio/mac/editor-behavior).
+
+## Code styles in EditorConfig files
+
+[Code style settings](../ide/editorconfig-code-style-settings-reference.md) for .NET can be specified by adding an [EditorConfig](create-portable-custom-editor-options.md) file to your project. EditorConfig files are associated with a codebase rather than a Visual Studio personalization account. Settings in an EditorConfig file take precedence over code styles that are specified in the **Options** dialog box. Use an EditorConfig file when you want to enforce coding styles for all contributors to your repo or project.
+
+::: moniker range=">=vs-2019"
+
+You can manually populate your EditorConfig file, or you can automatically generate the file based on code style settings you've set in the Visual Studio **Options** dialog box for the C# or Visual Basic text editor. This options page is available at **Tools** > **Options** > **Text Editor** > [**C#** or  **Basic**] > **Code Style** > **General**.
+Click **Generate .editorconfig file from settings** to automatically generate a coding style *.editorconfig* file based on the settings on this **Options** page.
+
+![Generate editorconfig file from settings in Visual Studio 2019](media/vs-2019/generate-editorconfig-file-small.png)
+
+::: moniker-end
+
+## Code styles in the Options dialog box
+
+Code style preferences can be set for all of your C# and Visual Basic projects by opening the **Options** dialog box from the **Tools** menu. In the **Options** dialog box, select **Text Editor** > [**C#** or  **Basic**] > **Code Style** > **General**.
+
+Each item in the list shows a preview of the preference when selected:
+
+::: moniker range="vs-2017"
+
+![Code style options](media/code-style-quick-actions-dialog.png)
+
+::: moniker-end
+
+::: moniker range=">=vs-2019"
+
+![Code style options](media/vs-2019/code-style-quick-actions-dialog.png)
+
+::: moniker-end
+
+Options set in this window are applicable to your Visual Studio personalization account and aren't associated with a particular project or codebase. In addition, they aren't enforced at build time, including in continuous integration (CI) builds. If you want to associate code style preferences with your project and have the styles enforced during build, specify the preferences in an [.editorconfig file](#code-styles-in-editorconfig-files) that's associated with the project.
+
+### Preference and severity
+
+For each code style setting on this page, you can set the **Preference** and **Severity** values using the drop-downs on each line. Severity can be set to **None**, **Suggestion**, **Warning**, or **Error**. If you want to enable [Quick Actions](../ide/quick-actions.md) for a code style, ensure that the **Severity** setting is set to something other than **None**. The **Quick Actions** light bulb ![light bulb](media/light-bulb-dropdown.png), error light bulb ![error light bulb](media/error-bulb.png), or screwdriver ![screwdriver](media/screwdriver.png) icon appears when a non-preferred style is used, and you can choose an option on the **Quick Actions** list to automatically rewrite code to the preferred style.
+
+## Apply code styles
+
+::: moniker range="vs-2017"
+
+You can configure the **Format Document** command (**Edit** > **Advanced** > **Format Document**) to apply your code style settings (from an EditorConfig file or **Code Style** options) along with the regular formatting that it does (such as indentation). If an *.editorconfig* file exists for the project, those settings take precedence.
+
+> [!NOTE]
+> Applying code styles by using the **Format Document** command is only available for C# code files. This is an experimental feature.
+
+Configure which settings you want **Format Document** to apply on the [Formatting options page](reference/options-text-editor-csharp-formatting.md#format-document-settings).
+
+![Code style settings for format document in Visual Studio 2017](media/format-document-settings-experiment.png)
+
+> [!TIP]
+> Rules configured with a severity of **None** don't participate in code cleanup but can be individually applied via the **Quick Actions and Refactorings** menu.
+
+The first time you trigger the **Format Document** command, a yellow info bar prompts you to configure your code cleanup settings.
+
+::: moniker-end
+
+::: moniker range=">=vs-2019"
+
+For C# code files, Visual Studio 2019 has a **Code Cleanup** button at the bottom of the editor (keyboard: **Ctrl**+**K**, **Ctrl**+**E**) to apply code styles from an EditorConfig file or from the **Code Style** options page. If an *.editorconfig* file exists for the project, those are the settings that take precedence.
+
+![Execute code cleanup in Visual Studio 2019](media/execute-code-cleanup.png)
+
+> [!TIP]
+> Rules configured with a severity of **None** don't participate in code cleanup but can be individually applied via the **Quick Actions and Refactorings** menu.
+
+First, configure which code styles you want to apply (in one of two profiles) in the **Configure Code Cleanup** dialog box. To open this dialog box, click the expander arrow next to the code cleanup broom icon and then choose **Configure Code Cleanup**. Or, press **Ctrl**+**K**, **Ctrl**+**Q**.
+
+![Configure Code Cleanup in Visual Studio 2019](media/configure-code-cleanup.png)
+
+If you want your code style settings to be applied every time you save a file, you may like the [Code Cleanup on Save](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.CodeCleanupOnSave) extension.
+
+::: moniker-end
+
+## See also
+
+- [Quick Actions](../ide/quick-actions.md)
+- [.NET coding convention settings for EditorConfig](../ide/editorconfig-code-style-settings-reference.md)
+- [Editor behavior (Visual Studio for Mac)](/visualstudio/mac/editor-behavior)

docs/ide/code-styles-and-quick-actions.md

@@ -14,7 +14,13 @@ You can add an [EditorConfig](http://editorconfig.org/) file to your project or
 
 EditorConfig settings are supported by numerous code editors and IDEs, including Visual Studio. It's a portable component that travels with your code, and can enforce coding styles even outside of Visual Studio.
 
-When you add an EditorConfig file to your project in Visual Studio, the formatting of existing code is not changed unless you format the document (**Edit** > **Advanced** > **Format Document** or **Ctrl**+**K**, **Ctrl**+**D** in the default profile). However, any new lines of code are formatted according to the EditorConfig settings. You can define which EditorConfig settings you want **Format Document** to apply on the [**Formatting** options page](reference/options-text-editor-csharp-formatting.md#format-document-settings).
+When you add an EditorConfig file to your project in Visual Studio, the formatting of existing code is not changed unless you format the document (**Edit** > **Advanced** > **Format Document** or **Ctrl**+**K**, **Ctrl**+**D** in the default profile). However, any new lines of code are formatted according to the EditorConfig settings.
+
+::: moniker range="vs-2017"
+
+You can define which EditorConfig settings you want **Format Document** to apply on the [**Formatting** options page](reference/options-text-editor-csharp-formatting.md#format-document-settings).
+
+::: moniker-end
 
 > [!NOTE]
 > This topic applies to Visual Studio on Windows. For Visual Studio for Mac, see [EditorConfig in Visual Studio for Mac](/visualstudio/mac/editorconfig).