Skip to content
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.

Sign up for GitHub

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

Deprecate CA1801 in favor of IDE0060 #21882

Merged
merged 3 commits into from
Dec 8, 2020
Merged

Deprecate CA1801 in favor of IDE0060 #21882

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc12d3c
Deprecate CA1801 in favor of IDE0060
Evangelink Dec 8, 2020
4a294f7
Update docs/fundamentals/code-analysis/quality-rules/ca1801.md
Evangelink Dec 8, 2020
a8a911a
Apply suggestions from code review
Evangelink Dec 8, 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
4 changes: 4 additions & 0 deletions docs/fundamentals/code-analysis/quality-rules/ca1801.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ This rule does not examine the following kinds of methods:

This rule does not flag parameters that are named with the [discard](../../../csharp/discards.md) symbol, for example, `_`, `_1`, and `_2`. This reduces warning noise on parameters that are needed for signature requirements, for example, a method used as a delegate, a parameter with special attributes, or a parameter whose value is implicitly accessed at run time by a framework but is not referenced in code.

> [!NOTE]
> This rule has been deprecated in favor of [IDE0060](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/ide0060). You can enforce this analyzer by following [this guide](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/overview#code-style-analysis).
Evangelink marked this conversation as resolved.
Show resolved Hide resolved
> For more information, see [Deprecated rules](https://docs.microsoft.com/visualstudio/code-quality/fxcop-unported-deprecated-rules).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do we need a parallel PR to MicrosoftDocs/visualstudio-docs page?
  • The linked page says deprecated rules for FxCop, which was deleted recently, so the change only affects NetAnalyzers package. Do the linked page needs to be updated regarding this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just suggest leaving this part out for now (for more info, see deprecated rules).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, those deprecated rules refer to FxCop rules that were never ported as an analyzer. CA1801 was ported, so I don't think it belongs in that list.

Evangelink marked this conversation as resolved.
Show resolved Hide resolved

## Rule description

Review parameters in non-virtual methods that are not used in the method body to make sure no incorrectness exists around failure to access them. Unused parameters incur maintenance and performance costs.
Expand Down