Skip to content

Commit 02fec6d

Browse files
authored
Merge pull request #5276 from Rageking8/disambiguate-visual-studio-code-and-visual-studio-code-x
Disambiguate "Visual Studio Code" and "Visual Studio Code *"
2 parents 0cfaace + 4a5ffee commit 02fec6d

File tree

4 files changed

+26
-27
lines changed

4 files changed

+26
-27
lines changed

docs/code-quality/quick-start-code-analysis-for-c-cpp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can improve the quality of your application by running code analysis regular
1919

2020
1. To run code analysis every time the project is built using the selected configuration, select the **Enable Code Analysis on Build** check box. You can also run code analysis manually by opening the **Analyze** menu and then choosing **Run Code Analysis on** *ProjectName* or **Run Code Analysis on File**.
2121

22-
1. Choose the [rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md) that you want to use or create a [custom rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md#to-create-a-rule-set-in-a-text-editor). If using LLVM/clang-cl, see [Using Clang-Tidy in Visual Studio](../code-quality/clang-tidy.md) to configure Clang-Tidy analysis options.
22+
1. Choose the [rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md) that you want to use or create a [custom rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md#to-create-a-rule-set-in-a-text-editor). If using LLVM/clang-cl, see [Using Clang-Tidy in Visual Studio](clang-tidy.md) to configure Clang-Tidy analysis options.
2323

2424
### Standard C/C++ rule sets
2525

@@ -100,7 +100,7 @@ The Error List window lists the code analysis warnings found. The results are di
100100

101101
For detailed information about the warning, including possible solutions to the issue, choose the warning ID in the Code column to display its corresponding online help article.
102102

103-
Double-click a warning to move the cursor to the line of code that caused the warning in the Visual Studio code editor. Or, press Enter on the selected warning.
103+
Double-click a warning to move the cursor to the line of code that caused the warning in the code editor. Or, press Enter on the selected warning.
104104

105105
After you understand the problem, you can resolve it in your code. Then, rerun code analysis to make sure that the warning no longer appears in the Error List.
106106

@@ -128,4 +128,4 @@ You can search long lists of warning messages and you can filter warnings in mul
128128

129129
## See also
130130

131-
- [Code analysis for C/C++](../code-quality/code-analysis-for-c-cpp-overview.md)
131+
- [Code analysis for C/C++](code-analysis-for-c-cpp-overview.md)

docs/code-quality/understanding-sal.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
description: "Learn more about: Understanding SAL"
32
title: Understanding SAL
3+
description: "Learn more about: Understanding SAL"
44
ms.date: 11/04/2016
55
ms.topic: "conceptual"
6-
ms.assetid: a94d6907-55f2-4874-9571-51d52d6edcfd
76
---
87
# Understanding SAL
98

@@ -94,9 +93,9 @@ These annotations help identify possible uninitialized values and invalid null p
9493
9594
This section shows code examples for the basic SAL annotations.
9695
97-
### Using the Visual Studio Code Analysis Tool to Find Defects
96+
### Using the Visual Studio code analysis tool to find defects
9897
99-
In the examples, the Visual Studio Code Analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
98+
In the examples, the Visual Studio code analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
10099
101100
#### To use Visual Studio code analysis tools and SAL
102101
@@ -145,7 +144,7 @@ void BadInCaller()
145144
}
146145
```
147146

148-
If you use Visual Studio Code Analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
147+
If you use Visual Studio code analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
149148

150149
### Example: The \_In\_opt\_ Annotation
151150

@@ -172,7 +171,7 @@ void InOptCaller()
172171
}
173172
```
174173
175-
Visual Studio Code Analysis validates that the function checks for NULL before it accesses the buffer.
174+
Visual Studio code analysis validates that the function checks for NULL before it accesses the buffer.
176175
177176
### Example: The \_Out\_ Annotation
178177
@@ -198,7 +197,7 @@ void OutCaller()
198197
}
199198
```
200199

201-
Visual Studio Code Analysis Tool validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
200+
Visual Studio code analysis validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
202201

203202
### Example: The \_Out\_opt\_ Annotation
204203

@@ -225,7 +224,7 @@ void OutOptCaller()
225224
}
226225
```
227226
228-
Visual Studio Code Analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
227+
Visual Studio code analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
229228
230229
### Example: The \_Inout\_ Annotation
231230
@@ -256,7 +255,7 @@ void BadInOutCaller()
256255
}
257256
```
258257

259-
Visual Studio Code Analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
258+
Visual Studio code analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
260259

261260
### Example: The \_Inout\_opt\_ Annotation
262261

@@ -285,7 +284,7 @@ void InOutOptCaller()
285284
}
286285
```
287286
288-
Visual Studio Code Analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
287+
Visual Studio code analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
289288
290289
### Example: The \_Outptr\_ Annotation
291290
@@ -315,7 +314,7 @@ void OutPtrCaller()
315314
}
316315
```
317316

318-
Visual Studio Code Analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
317+
Visual Studio code analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
319318

320319
### Example: The \_Outptr\_opt\_ Annotation
321320

@@ -347,7 +346,7 @@ void OutPtrOptCaller()
347346
}
348347
```
349348
350-
Visual Studio Code Analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
349+
Visual Studio code analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
351350
352351
### Example: The \_Success\_ Annotation in Combination with \_Out\_
353352
@@ -366,7 +365,7 @@ bool GetValue(_Out_ int *pInt, bool flag)
366365
}
367366
```
368367

369-
The `_Out_` annotation causes Visual Studio Code Analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
368+
The `_Out_` annotation causes Visual Studio code analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
370369

371370
## SAL Best Practice
372371

@@ -384,18 +383,18 @@ Here are some guidelines:
384383

385384
- Annotate value-range annotations so that Code Analysis can ensure buffer and pointer safety.
386385

387-
- Annotate locking rules and locking side effects. For more information, see [Annotating Locking Behavior](../code-quality/annotating-locking-behavior.md).
386+
- Annotate locking rules and locking side effects. For more information, see [Annotating Locking Behavior](annotating-locking-behavior.md).
388387

389388
- Annotate driver properties and other domain-specific properties.
390389

391390
Or you can annotate all parameters to make your intent clear throughout and to make it easy to check that annotations have been done.
392391

393392
## See also
394393

395-
- [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md)
396-
- [Annotating Function Parameters and Return Values](../code-quality/annotating-function-parameters-and-return-values.md)
397-
- [Annotating Function Behavior](../code-quality/annotating-function-behavior.md)
398-
- [Annotating Structs and Classes](../code-quality/annotating-structs-and-classes.md)
399-
- [Annotating Locking Behavior](../code-quality/annotating-locking-behavior.md)
400-
- [Specifying When and Where an Annotation Applies](../code-quality/specifying-when-and-where-an-annotation-applies.md)
401-
- [Best Practices and Examples](../code-quality/best-practices-and-examples-sal.md)
394+
- [Using SAL Annotations to Reduce C/C++ Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
395+
- [Annotating Function Parameters and Return Values](annotating-function-parameters-and-return-values.md)
396+
- [Annotating Function Behavior](annotating-function-behavior.md)
397+
- [Annotating Structs and Classes](annotating-structs-and-classes.md)
398+
- [Annotating Locking Behavior](annotating-locking-behavior.md)
399+
- [Specifying When and Where an Annotation Applies](specifying-when-and-where-an-annotation-applies.md)
400+
- [Best Practices and Examples](best-practices-and-examples-sal.md)

docs/code-quality/using-the-cpp-core-guidelines-checkers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,11 +317,11 @@ Because of the way the code analysis rules get loaded within Visual Studio 2015,
317317

318318
1. In the **NuGet Package Manager** window, search for Microsoft.CppCoreCheck.
319319

320-
![Nuget Package Manager window showing the CppCoreCheck package.](../code-quality/media/cppcorecheck_nuget_window.png)
320+
![Nuget Package Manager window showing the CppCoreCheck package.](media/cppcorecheck_nuget_window.png)
321321

322322
1. Select the Microsoft.CppCoreCheck package and then choose the **Install** button to add the rules to your project.
323323

324-
The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio Code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
324+
The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
325325

326326
::: moniker-end
327327

docs/embedded/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
items:
2-
- name: Embedded development with Visual Studio and Visual Studio code
2+
- name: Embedded development with Visual Studio and Visual Studio Code
33
href: ./index.yml
44
- name: Download and install the Embedded Tools
55
href: download-and-install-the-embedded-tooling.md

0 commit comments

Comments
 (0)