Skip to content

Commit 7109422

Browse files
damabedamabe
committed
Merge branch 'master' of https://github.com/microsoft/visualstudio-docs-pr into 1235779
2 parents 24f4365 + c81981d commit 7109422

40 files changed

+770
-131
lines changed

‎.openpublishing.redirection.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,6 @@
130130
"redirect_url": "/visualstudio/code-quality/code-analysis-for-managed-code-overview",
131131
"redirect_document_id": false
132132
},
133-
{
134-
"source_path": "docs/code-quality/index.md",
135-
"redirect_url": "/visualstudio/code-quality/code-analysis-for-managed-code-overview",
136-
"redirect_document_id": false
137-
},
138133
{
139134
"source_path": "docs/code-quality/measuring-complexity-and-maintainability-of-managed-code.md",
140135
"redirect_url": "/visualstudio/code-quality/code-metrics-values/",

‎docs/code-quality/index.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
layout: LandingPage
3+
title: Code analysis
4+
description: Learn how to use Visual Studio 2017 to analyze code quality.
5+
ms.prod: visual-studio-dev15
6+
ms.technology: vs-ide-code-analysis
7+
ms.topic: landing-page
8+
ms.author: gewarren
9+
author: gewarren
10+
manager: douge
11+
---
12+
# Code analysis in Visual Studio
13+
14+
Visual Studio provides several different tools to analyze and improve code quality.
15+
16+
<br />
17+
18+
<ul class="panelContent cardsFTitle">
19+
<li>
20+
<a href="code-analysis-for-managed-code-overview.md">
21+
<div class="cardSize">
22+
<div class="cardPadding">
23+
<div class="card">
24+
<div class="cardImageOuter">
25+
<div class="cardImage">
26+
<img src="https://docs.microsoft.com/media/common/i_code-quality.svg" alt="Code quality icon">
27+
</div>
28+
</div>
29+
<div class="cardText">
30+
<h3>Analyze managed code quality</h3>
31+
</div>
32+
</div>
33+
</div>
34+
</div>
35+
</a>
36+
</li>
37+
<li>
38+
<a href="code-analysis-for-c-cpp-overview.md">
39+
<div class="cardSize">
40+
<div class="cardPadding">
41+
<div class="card">
42+
<div class="cardImageOuter">
43+
<div class="cardImage">
44+
<img src="https://docs.microsoft.com/media/logos/logo_Cplusplus.svg" alt="C++ logo">
45+
</div>
46+
</div>
47+
<div class="cardText">
48+
<h3>Analyze C and C++ code quality</h3>
49+
</div>
50+
</div>
51+
</div>
52+
</div>
53+
</a>
54+
</li>
55+
<li>
56+
<a href="code-metrics-values.md">
57+
<div class="cardSize">
58+
<div class="cardPadding">
59+
<div class="card">
60+
<div class="cardImageOuter">
61+
<div class="cardImage">
62+
<img src="https://docs.microsoft.com/media/common/i_data-collection.svg" alt="Data collection icon">
63+
</div>
64+
</div>
65+
<div class="cardText">
66+
<h3>Measure code maintainability with code metrics</h3>
67+
</div>
68+
</div>
69+
</div>
70+
</div>
71+
</a>
72+
</li>
73+
</ul>
74+
75+
<hr>
76+
<h2>Reference</h2>
77+
78+
<ul class="panelContent cardsW">
79+
<li>
80+
<a href="https://docs.microsoft.com/visualstudio/code-quality/code-analysis-for-managed-code-warnings">
81+
<div class="cardSize">
82+
<div class="cardPadding">
83+
<div class="card">
84+
<div class="cardText">
85+
<h3>Managed code analysis warnings</h3>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
</a>
91+
</li>
92+
<li>
93+
<a href="https://docs.microsoft.com/visualstudio/code-quality/code-analysis-for-c-cpp-warnings">
94+
<div class="cardSize">
95+
<div class="cardPadding">
96+
<div class="card">
97+
<div class="cardText">
98+
<h3>C++ code analysis warnings</h3>
99+
</div>
100+
</div>
101+
</div>
102+
</div>
103+
</a>
104+
</li>
105+
<li>
106+
<a href="https://docs.microsoft.com/visualstudio/code-quality/rule-set-reference">
107+
<div class="cardSize">
108+
<div class="cardPadding">
109+
<div class="card">
110+
<div class="cardText">
111+
<h3>Rule sets</h3>
112+
</div>
113+
</div>
114+
</div>
115+
</div>
116+
</a>
117+
</li>
118+
</ul>

‎docs/code-quality/media/error-list-filter.png

2.25 KB
Loading

‎docs/code-quality/toc.yml

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1+
- name: Code analysis documentation
2+
href: index.md
13
- name: Overview
24
items:
3-
- name: Code Analysis for Managed Code
5+
- name: Code analysis for managed code
46
href: code-analysis-for-managed-code-overview.md
5-
- name: Roslyn Analyzers
7+
- name: Roslyn analyzers
68
href: roslyn-analyzers-overview.md
7-
- name: Code Analysis for C/C++
9+
- name: Code analysis for C/C++
810
href: code-analysis-for-c-cpp-overview.md
9-
- name: Measure Code Maintainability with Code Metrics
11+
- name: Measure code maintainability with code metrics
1012
href: code-metrics-values.md
1113
- name: Quickstarts
1214
items:
13-
- name: "Quickstart: Code Analysis for C/C++"
15+
- name: "Quickstart: Code analysis for C/C++"
1416
href: quick-start-code-analysis-for-c-cpp.md
1517
- name: Tutorials
1618
items:
17-
- name: Analyze Managed Code for Code Defects
19+
- name: Analyze managed code for code defects
1820
href: walkthrough-analyzing-managed-code-for-code-defects.md
19-
- name: Analyze C/C++ Code for Defects
21+
- name: Analyze C/C++ code for defects
2022
href: walkthrough-analyzing-c-cpp-code-for-defects.md
2123
items:
22-
- name: Demo Sample
24+
- name: Demo sample
2325
href: demo-sample.md
2426
- name: How-to guides
2527
items:
26-
- name: Code Analysis for Managed Code
28+
- name: Code analysis for managed code
2729
items:
2830
- name: Install Roslyn Analyzers
2931
href: install-roslyn-analyzers.md
@@ -48,7 +50,7 @@
4850
href: anonymous-methods-and-code-analysis.md
4951
- name: Create a Work Item for a Managed Code Defect
5052
href: how-to-create-a-work-item-for-a-managed-code-defect.md
51-
- name: Code Analysis for C/C++
53+
- name: Code analysis for C/C++
5254
items:
5355
- name: Use the C++ Core Guidelines checkers
5456
href: using-the-cpp-core-guidelines-checkers.md
@@ -75,7 +77,7 @@
7577
href: best-practices-and-examples-sal.md
7678
- name: Specify Additional Code Information by Using _Analysis_assume
7779
href: how-to-specify-additional-code-information-by-using-analysis-assume.md
78-
- name: Rule Sets
80+
- name: Rule sets
7981
href: using-rule-sets-to-group-code-analysis-rules.md
8082
items:
8183
- name: Rule Sets for Managed Code
@@ -89,7 +91,7 @@
8991
href: how-to-create-a-custom-rule-set.md
9092
- name: Use the Rule Set Editor
9193
href: working-in-the-code-analysis-rule-set-editor.md
92-
- name: Check-in Policies
94+
- name: Check-in policies
9395
href: how-to-create-or-update-standard-code-analysis-check-in-policies.md
9496
items:
9597
- name: Implement Custom Code Analysis Check-in Policies for Managed Code
@@ -100,7 +102,7 @@
100102
href: how-to-synchronize-code-project-rule-sets-with-team-project-check-in-policy.md
101103
- name: Version Compatibility
102104
href: version-compatibility-for-code-analysis-check-in-policies.md
103-
- name: Code Metrics
105+
- name: Code metrics
104106
items:
105107
- name: Generate Code Metrics Data
106108
href: how-to-generate-code-metrics-data.md
@@ -137,7 +139,7 @@
137139
href: native-recommended-rules-rule-set.md
138140
- name: Security Rules rule set for managed code
139141
href: security-rules-rule-set-for-managed-code.md
140-
- name: Code Analysis for Managed Code Warnings
142+
- name: Code analysis for managed code warnings
141143
href: code-analysis-for-managed-code-warnings.md
142144
items:
143145
- name: Code Analysis Warnings for Managed Code by CheckId
@@ -149,7 +151,7 @@
149151
href: ca5350-do-not-use-weak-cryptographic-algorithms.md
150152
- name: "CA5351 Do Not Use Broken Cryptographic Algorithms"
151153
href: ca5351-do-not-use-broken-cryptographic-algorithms.md
152-
- name: Design Warnings
154+
- name: Design warnings
153155
href: design-warnings.md
154156
items:
155157
- name: "CA1000: Do not declare static members on generic types"

‎docs/code-quality/use-roslyn-analyzers.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,11 @@ There are multiple ways to suppress rule violations:
109109

110110
![Suppress diagnostic from quick actions menu](media/suppress-diagnostic-from-editor.png)
111111

112-
- To suppress a diagnostic from the **Error List**, right-click on the error, warning, or message, and select **Suppress** > **In Source** or **Suppress** > **In Suppression File**.
112+
- To suppress a diagnostic from the **Error List**, see [Suppress violations from the Error List](#suppress-violations-from-the-error-list).
113+
114+
### Suppress violations from the Error List
115+
116+
You can suppress one or many diagnostics from the **Error List** by selecting the ones you want to suppress, and then right-clicking and selecting **Suppress** > **In Source** or **Suppress** > **In Suppression File**.
113117

114118
- If you select **In Source**, the **Preview Changes** dialog opens and shows a preview of the C# [#pragma warning](/dotnet/csharp/language-reference/preprocessor-directives/preprocessor-pragma-warning) or Visual Basic [#Disable warning](/dotnet/visual-basic/language-reference/directives/directives) directive that's added to the source code.
115119

@@ -121,6 +125,10 @@ There are multiple ways to suppress rule violations:
121125

122126
In the **Preview Changes** dialog, select **Apply**.
123127

128+
The **Error List** displays diagnostics, or rule violations, from both live code analysis and build. Since the build diagnostics can be stale, for example, if you've edited the code to fix the violation but haven't rebuilt, you cannot suppress these diagnostics from the **Error List**. However, diagnostics from live analysis, or IntelliSense, are always up-to-date with current sources, and can be suppressed from the **Error List**. If the suppression option is disabled in the right-click, or context, menu, it's likely because you have one or more build diagnostics in your selection. To exclude the build diagnostics from your selection, switch the **Error List** source filter from **Build + IntelliSense** to **Intellisense Only**. Then, select the diagnostics you want to suppress and proceed as described previously.
129+
130+
![Error List source filter in Visual Studio](media/error-list-filter.png)
131+
124132
> [!NOTE]
125133
> In a .NET Core project, if you add a reference to a project that has NuGet analyzers, those analyzers are automatically added to the dependent project too. To disable this behavior, for example if the dependent project is a unit test project, mark the NuGet package as private in the *.csproj* or *.vbproj* file of the referenced project:
126134
>

‎docs/data-tools/toc.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
- name: Overview
2-
items:
3-
- name: Access data in Visual Studio
4-
href: accessing-data-in-visual-studio.md
2+
href: accessing-data-in-visual-studio.md
53
- name: Tutorials
64
items:
75
- name: Create a simple data app by using ADO.NET

‎docs/deployment/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: LandingPage
33
title: Deploying your Apps in Visual Studio | Microsoft Docs
44
description: Learn how use Visual Studio 2017 to deploy applications, services, and components.
55
ms.topic: landing-page
6+
ms.prod: visual-studio-dev15
67
ms.technology: vs-ide-deployment
78
ms.author: "mikejo"
89
author: "mikejo5000"
@@ -44,7 +45,7 @@ Visual Studio provides several different tools to help you deploy your apps.
4445
</div>
4546
</div>
4647
<div class="cardText">
47-
<h3>Deploy to a Local Folder</h3>
48+
<h3>Deploy to a local folder</h3>
4849
</div>
4950
</div>
5051
</div>
@@ -62,7 +63,7 @@ Visual Studio provides several different tools to help you deploy your apps.
6263
</div>
6364
</div>
6465
<div class="cardText">
65-
<h3>Deploy to a Website or Network Share</h3>
66+
<h3>Deploy to a website or network share</h3>
6667
</div>
6768
</div>
6869
</div>

‎docs/extensibility/installing-the-visual-studio-sdk.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Installing the Visual Studio SDK | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "07/12/2018"
55
ms.technology: vs-ide-sdk
66
ms.topic: "conceptual"
77
ms.assetid: c730edb6-5099-4c16-85a8-08def09f1455
@@ -12,20 +12,25 @@ ms.workload:
1212
- "vssdk"
1313
---
1414
# Installing the Visual Studio SDK
15-
The Visual Studio SDK is an optional feature in Visual Studio setup. You can also install the VS SDK later on.
15+
16+
The Visual Studio SDK (Software Development Kit) is an optional feature in Visual Studio setup. You can also install the VS SDK later on.
1617

17-
## Installing the Visual Studio SDK as Part of a Visual Studio Installation
18-
If you'd like to include the VSSDK in your Visual Studio installation, you should install the **Visual Studio extension development** Workload under **Other Toolsets**. This will install the Visual Studio SDK as well as the necessary prerequisites. You can further tune the installation by selecting or unselecting Components from the Summary view.
18+
## Installing the Visual Studio SDK as part of a Visual Studio installation
19+
20+
To include the VS SDK in your Visual Studio installation, install the **Visual Studio extension development** workload under **Other Toolsets**. This workload will install the Visual Studio SDK and the necessary prerequisites. You can further tune the installation by selecting or unselecting components from the **Summary** view.
1921

20-
## Installing the Visual Studio SDK after Installing Visual Studio
21-
If you decide to install the Visual Studio SDK after completing your Visual Studio installation, rerun the Visual Studio installer and select the **Visual Studio extension development** Workload.
22+
## Installing the Visual Studio SDK after installing Visual Studio
23+
24+
To install the Visual Studio SDK after completing your Visual Studio installation, rerun the Visual Studio installer and select the **Visual Studio extension development** workload.
2225

23-
## Installing the Visual Studio SDK from a Solution
24-
If you open a solution with an extensibility project without first installing the VSSDK, you will be prompted by a highlighted information bar above the Solution Explorer. It should look something like the following:
26+
## Installing the Visual Studio SDK from a Solution
27+
28+
If you open a solution with an extensibility project without first installing the VS SDK, you will be prompted by an **Install Missing Feature** dialog to install the **Visual Studio extension development** workload:
29+
30+
![Install extension development](../extensibility/media/install-extension-development.png "Install extension development")
2531

26-
![SolutionExplorerInstall](../extensibility/media/solutionexplorerinstall.png "SolutionExplorerInstall")
32+
## Installing the Visual Studio SDK from the command line
33+
34+
As with any Visual Studio workload or component, you can also install the **Visual Studio extension development** workload (ID: Microsoft.VisualStudio.Workload.VisualStudioExtension) from the command line. See [Use command-line parameters to install Visual Studio](../install/use-command-line-parameters-to-install-visual-studio.md) for details on the appropriate command-line switches and general instructions on determining workload or component identifiers.
2735

28-
## Installing the Visual Studio SDK from the Command Line
29-
As with any Visual Studio Workload or Component, you can also install the **Visual Studio extension development** Workload (ID: Microsoft.VisualStudio.Workload.VisualStudioExtension) from the command line. See [Use command-line parameters to install Visual Studio](../install/use-command-line-parameters-to-install-visual-studio.md) for details on the appropriate command line switches and general instructions on determining Workload or Component identifiers.
30-
31-
Note that you must use the Visual Studio installer that matches your installed version of Visual Studio. For example, if you have Visual Studio Enterprise installed on your computer, you must run the Visual Studio Enterprise installer (vs_enterprise.exe).
36+
Note that you must use the Visual Studio installer that matches your installed version of Visual Studio. For example, if you have Visual Studio Enterprise installed on your computer, you must run the Visual Studio Enterprise installer (vs_enterprise.exe).

‎docs/extensibility/media/install-extension-development.png

11.7 KB
Loading

‎docs/extensibility/media/lsp-implementation.png

-62.2 KB
Loading

‎docs/extensibility/media/lsp-service-in-VS.png

-55.4 KB
Loading

‎docs/extensibility/media/manage-performance.png

-31.4 KB
Loading

0 commit comments

Comments
 (0)