Skip to content

Repo sync for protected CLA branch #5757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 52 commits into from
Aug 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
aa7e77e
add more info to conditions topic
ghogen Jul 29, 2020
40b40a8
Added doc focused What's New
JoshuaPartlow Aug 6, 2020
cf24ab4
Title and file rename for clarity
JoshuaPartlow Aug 6, 2020
88e6419
Creating new help page for installer projects .NET Core 3.1 features
MSLukeWest Aug 7, 2020
2286934
Addressing Acrolinx comments
MSLukeWest Aug 8, 2020
78d6bc7
removed label filter and reran
JoshuaPartlow Aug 13, 2020
f1f91dd
Merge branch 'master' into jp-vsupdate-5
JoshuaPartlow Aug 13, 2020
06f7efe
Changed lvl 3 headers to bold
JoshuaPartlow Aug 13, 2020
d2c26e3
Moving new page, plus adding screenshots and text edits
MSLukeWest Aug 18, 2020
66e5580
Adding monikerRange property
MSLukeWest Aug 19, 2020
3e68310
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
c8e5ada
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
7bb0c1b
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
35e9e2f
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
9ed1ba9
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
1eaf18b
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
3e8afa3
Fixing grammar mistake and image links
MSLukeWest Aug 19, 2020
92cf6a5
Fixing spacing issue
MSLukeWest Aug 19, 2020
f98a96b
Update docs/deployment/installer-projects-netcore.md
MSLukeWest Aug 19, 2020
e1f106f
Adding missing 'the'
MSLukeWest Aug 19, 2020
87afa06
File naming and formatting fixes
MSLukeWest Aug 19, 2020
4460884
Remove FxCop/FxCop analyzers terminology in CA rule docs
mavasani Aug 20, 2020
7ddff3a
Fix conflicts
mavasani Aug 20, 2020
55b864e
Fix reference
mavasani Aug 20, 2020
46d48ef
Fix wording
mavasani Aug 20, 2020
6b3a31b
Address feedback
mavasani Aug 20, 2020
b91aaf9
Update docs/code-quality/ca1053.md
mavasani Aug 20, 2020
44843a0
Update docs/code-quality/ca1508.md
mavasani Aug 20, 2020
ef33ac6
Update docs/code-quality/configure-fxcop-analyzers.md
mavasani Aug 20, 2020
fff62f5
Update docs/code-quality/configure-fxcop-analyzers.md
mavasani Aug 20, 2020
de2ea74
Update docs/code-quality/how-to-generate-code-metrics-data.md
mavasani Aug 20, 2020
fc537d4
Update docs/code-quality/fxcop-analyzer-options.md
mavasani Aug 20, 2020
eb7bc80
add sentence about developer cert
ghogen Aug 20, 2020
4fc1bbc
hyphenate
ghogen Aug 20, 2020
c29e1b3
special characters for seo
ghogen Aug 20, 2020
49c9d9f
Merge pull request #7033 from ghogen/container-tools
PRMerger6 Aug 20, 2020
bc7444d
Merge pull request #7032 from mavasani/RemoveFxCopTerms
v-albemi Aug 20, 2020
2df64a9
Merge pull request #7034 from ghogen/seo-work
ghogen Aug 20, 2020
d03fe31
Merge pull request #6984 from MSLukeWest/master
v-shmck Aug 20, 2020
4276e78
Update docs/msbuild/msbuild-conditions.md
ghogen Aug 20, 2020
909affa
Update docs/msbuild/msbuild-conditions.md
ghogen Aug 20, 2020
c4ce979
Update docs/msbuild/msbuild-conditions.md
ghogen Aug 20, 2020
67f74b2
add info on conditions
ghogen Aug 20, 2020
d5f61eb
Merge pull request #6935 from ghogen/msbuild-conditions
PRMerger18 Aug 20, 2020
231ebae
Merge pull request #6972 from JoshuaPartlow/jp-vsupdate-5
American-Dipper Aug 20, 2020
36fd66d
change fonts & colors quickstart to how-to
TerryGLee Aug 20, 2020
c92b4d2
add description metadata and seo ms.custom metadata
TerryGLee Aug 20, 2020
d08006f
fine-tune the description statements
TerryGLee Aug 20, 2020
fd2c823
fine-tune intro statements and See Also links
TerryGLee Aug 20, 2020
8172bd2
update the TOC to remove Quickstart from link text
TerryGLee Aug 20, 2020
de98ed7
Merge pull request #7037 from TerryGLee/tglee-perf
ShannonLeavitt Aug 20, 2020
d3485be
Merging changes synced from https://github.com/MicrosoftDocs/visualst…
ghogen Aug 20, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/code-quality/analyzers-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This page contains answers to some frequently asked questions about .NET Compile

**Q**: Should I use code analysis or EditorConfig for checking code style?

**A**: Code analysis 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 code analyzers that are built into Visual Studio. EditorConfig files can be used to enable or disable analyzer rules, and also to configure some NuGet analyzer packages, such as [FxCop analyzers](configure-fxcop-analyzers.md).
**A**: Code analysis 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 code analyzers that are built into Visual Studio. EditorConfig files can be used to enable or disable analyzer rules, and also to configure NuGet analyzer packages.

## EditorConfig versus rule sets

Expand All @@ -28,8 +28,8 @@ This page contains answers to some frequently asked questions about .NET Compile

However, EditorConfig files offer additional ways to configure rules too:

- For FxCop analyzers, EditorConfig files let you [define which types of code to analyze](fxcop-analyzer-options.md).
- For the code-style analyzers that are built into Visual Studio, EditorConfig files let you [define the preferred code styles](../ide/editorconfig-code-style-settings-reference.md) for a codebase.
- For the .NET code-quality analyzers, EditorConfig files let you [define which types of code to analyze](fxcop-analyzer-options.md).
- For the .NET code-style analyzers that are built into Visual Studio, EditorConfig files let you [define the preferred code styles](../ide/editorconfig-code-style-settings-reference.md) for a codebase.

In addition to rule sets and EditorConfig files, some analyzers are configured through the use of text files marked as [additional files](../ide/build-actions.md#build-action-values) for the C# and VB compilers.

Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1000.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ Do not suppress a warning from this rule. Providing generics in a syntax that is

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1000.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Related rules

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/ca1001.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A class declares and implements an instance field that is a <xref:System.IDispos
## Rule description
A class implements the <xref:System.IDisposable> interface to dispose of unmanaged resources that it owns. An instance field that is an <xref:System.IDisposable> type indicates that the field owns an unmanaged resource. A class that declares an <xref:System.IDisposable> field indirectly owns an unmanaged resource and should implement the <xref:System.IDisposable> interface. If the class does not directly own any unmanaged resources, it should not implement a finalizer.

Starting with FxCop analyzers 3.x, this rule respects types implementing <xref:System.IAsyncDisposable?displayProperty=fullName> as disposable types.
This rule respects types implementing <xref:System.IAsyncDisposable?displayProperty=fullName> as disposable types.

## How to fix violations
To fix a violation of this rule, implement <xref:System.IDisposable> and from the <xref:System.IDisposable.Dispose%2A?displayProperty=fullName> method call the <xref:System.IDisposable.Dispose%2A> method of the field.
Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1003.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ Do not suppress a warning from this rule.

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1003.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Example

Expand Down
6 changes: 2 additions & 4 deletions docs/code-quality/ca1008.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -49,19 +48,18 @@ Do not suppress a warning from this rule except for flags-attributed enumeration

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1008.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Example

The following example shows two enumerations that satisfy the rule and an enumeration, `BadTraceOptions`, that violates the rule.

[!code-cpp[FxCop.Design.EnumsZeroValue#1](../code-quality/codesnippet/CPP/ca1008-enums-should-have-zero-value_1.cpp)]
[!code-csharp[FxCop.Design.EnumsZeroValue#1](../code-quality/codesnippet/CSharp/ca1008-enums-should-have-zero-value_1.cs)]
[!code-vb[FxCop.Design.EnumsZeroValue#1](../code-quality/codesnippet/VisualBasic/ca1008-enums-should-have-zero-value_1.vb)]

Expand Down
4 changes: 1 addition & 3 deletions docs/code-quality/ca1009.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand All @@ -31,7 +30,7 @@ ms.workload:
A delegate that handles a public or protected event does not have the correct signature, return type, or parameter names.

> [!NOTE]
> This legacy rule is not available in FxCop Analyzers. For more information, see [Deprecated rules](fxcop-rule-port-status.md#deprecated-rules).
> This rule has been deprecated. For more information, see [Deprecated rules](fxcop-rule-port-status.md#deprecated-rules).

## Rule description
Event handler methods take two parameters. The first is of type <xref:System.Object?displayProperty=fullName> and is named 'sender'. This is the object that raised the event. The second parameter is of type <xref:System.EventArgs?displayProperty=fullName> and is named 'e'. This is the data that is associated with the event. For example, if the event is raised whenever a file is opened, the event data typically contains the name of the file.
Expand All @@ -47,7 +46,6 @@ Do not suppress a warning from this rule.
## Example
The following example shows a delegate that is suited to handling events. The methods that can be invoked by this event handler comply with the signature that is specified in the Design Guidelines. `AlarmEventHandler` is the type name of the delegate. `AlarmEventArgs` derives from the base class for event data, <xref:System.EventArgs>, and holds alarm event data.

[!code-cpp[FxCop.Design.EventsTwoParams#1](../code-quality/codesnippet/CPP/ca1009-declare-event-handlers-correctly_1.cpp)]
[!code-csharp[FxCop.Design.EventsTwoParams#1](../code-quality/codesnippet/CSharp/ca1009-declare-event-handlers-correctly_1.cs)]
[!code-vb[FxCop.Design.EventsTwoParams#1](../code-quality/codesnippet/VisualBasic/ca1009-declare-event-handlers-correctly_1.vb)]

Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1010.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ It is safe to suppress a warning from this rule; however, the use of the collect

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1010.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

### Additional required generic interfaces

Expand Down
2 changes: 0 additions & 2 deletions docs/code-quality/ca1011.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -56,7 +55,6 @@ In these cases, the code will be more robust because of the strong type checking
The following example shows a method, `ManipulateFileStream`, that can be used only with a <xref:System.IO.FileStream> object, which violates this rule. A second method, `ManipulateAnyStream`, satisfies the rule by replacing the <xref:System.IO.FileStream> parameter by using a <xref:System.IO.Stream>.

[!code-csharp[FxCop.Design.ConsiderPassingBaseTypes#1](../code-quality/codesnippet/CSharp/ca1011-consider-passing-base-types-as-parameters_1.cs)]
[!code-cpp[FxCop.Design.ConsiderPassingBaseTypes#1](../code-quality/codesnippet/CPP/ca1011-consider-passing-base-types-as-parameters_1.cpp)]
[!code-vb[FxCop.Design.ConsiderPassingBaseTypes#1](../code-quality/codesnippet/VisualBasic/ca1011-consider-passing-base-types-as-parameters_1.vb)]

## Related rules
Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1012.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ Do not suppress a warning from this rule. The abstract type has a public constru

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1012.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Example

Expand Down
2 changes: 0 additions & 2 deletions docs/code-quality/ca1014.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -45,7 +44,6 @@ Do not suppress a warning from this rule. If you do not want the assembly to be
The following example shows an assembly that has the <xref:System.CLSCompliantAttribute?displayProperty=fullName> attribute applied that declares it CLS-compliant.

[!code-csharp[FxCop.Design.AssembliesCls#1](../code-quality/codesnippet/CSharp/ca1014-mark-assemblies-with-clscompliantattribute_1.cs)]
[!code-cpp[FxCop.Design.AssembliesCls#1](../code-quality/codesnippet/CPP/ca1014-mark-assemblies-with-clscompliantattribute_1.cpp)]
[!code-vb[FxCop.Design.AssembliesCls#1](../code-quality/codesnippet/VisualBasic/ca1014-mark-assemblies-with-clscompliantattribute_1.vb)]

## See also
Expand Down
2 changes: 0 additions & 2 deletions docs/code-quality/ca1016.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -59,7 +58,6 @@ The following example shows an assembly that has the <xref:System.Reflection.Ass

[!code-csharp[FxCop.Design.AssembliesVersion#1](../code-quality/codesnippet/CSharp/ca1016-mark-assemblies-with-assemblyversionattribute_1.cs)]
[!code-vb[FxCop.Design.AssembliesVersion#1](../code-quality/codesnippet/VisualBasic/ca1016-mark-assemblies-with-assemblyversionattribute_1.vb)]
[!code-cpp[FxCop.Design.AssembliesVersion#1](../code-quality/codesnippet/CPP/ca1016-mark-assemblies-with-assemblyversionattribute_1.cpp)]

## See also

Expand Down
2 changes: 0 additions & 2 deletions docs/code-quality/ca1017.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -42,7 +41,6 @@ Do not suppress a warning from this rule. If you want the assembly to be visible
## Example
The following example shows an assembly that has the <xref:System.Runtime.InteropServices.ComVisibleAttribute> attribute applied to prevent it from being visible to COM clients.

[!code-cpp[FxCop.Design.AssembliesCom#1](../code-quality/codesnippet/CPP/ca1017-mark-assemblies-with-comvisibleattribute_1.cpp)]
[!code-vb[FxCop.Design.AssembliesCom#1](../code-quality/codesnippet/VisualBasic/ca1017-mark-assemblies-with-comvisibleattribute_1.vb)]
[!code-csharp[FxCop.Design.AssembliesCom#1](../code-quality/codesnippet/CSharp/ca1017-mark-assemblies-with-comvisibleattribute_1.cs)]

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/ca1020.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ms.workload:
A namespace other than the global namespace contains fewer than five types.

> [!NOTE]
> This legacy rule is not available in FxCop Analyzers. For more information, see [Deprecated rules](fxcop-rule-port-status.md#deprecated-rules).
> This rule has been deprecated. For more information, see [Deprecated rules](fxcop-rule-port-status.md#deprecated-rules).

## Rule description

Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1021.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ It is safe to suppress a warning from this rule. However, this design could caus

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1021.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Example
The following library shows two implementations of a class that generates responses to the feedback of a user. The first implementation (`BadRefAndOut`) forces the library user to manage three return values. The second implementation (`RedesignedRefAndOut`) simplifies the user experience by returning an instance of a container class (`ReplyData`) that manages the data as a single unit.
Expand Down
2 changes: 0 additions & 2 deletions docs/code-quality/ca1023.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ author: mikejo5000
ms.author: mikejo
manager: jillfra
dev_langs:
- CPP
- CSharp
- VB
ms.workload:
Expand Down Expand Up @@ -43,7 +42,6 @@ Suppress a warning from this rule only after carefully considering the need for
The following example shows a type, `DayOfWeek03`, with a multi-dimensional indexer that violates the rule. The indexer can be seen as a type of conversion and therefore is more appropriately exposed as a method. The type is redesigned in `RedesignedDayOfWeek03` to satisfy the rule.

[!code-vb[FxCop.Design.OneDimensionForIndexer#1](../code-quality/codesnippet/VisualBasic/ca1023-indexers-should-not-be-multidimensional_1.vb)]
[!code-cpp[FxCop.Design.OneDimensionForIndexer#1](../code-quality/codesnippet/CPP/ca1023-indexers-should-not-be-multidimensional_1.cpp)]
[!code-csharp[FxCop.Design.OneDimensionForIndexer#1](../code-quality/codesnippet/CSharp/ca1023-indexers-should-not-be-multidimensional_1.cs)]

## Related rules
Expand Down
4 changes: 2 additions & 2 deletions docs/code-quality/ca1024.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ Suppress a warning from this rule if the method meets at least one of the previo

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1024.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure .NET code-quality analyzers](configure-fxcop-analyzers.md).

## Control property expansion in the debugger

Expand Down
Loading