Tracking issue for missing documentation of .NET6 CAxxxx rules

[Youssef1313]

TODO

• CA1419 added in Implement Analyzer and best-effort Code Fix for SafeHandle Public Parameterless Constructor guidance. roslyn-analyzers#5043.
• CA1727
• CA1842 and CA1843 added in Add WhenAll and WaitAll analyzer for single task argument roslyn-analyzers#4841
• CA1848
• CA2017
• CA2253
• CA2254 added in Enabled logging analyzer on new repo roslyn-analyzers#5244.
• CA2256
• CA2257
• CA2258

Done

• CA1418 added in CA-1418 Validate platform string roslyn-analyzers#4838.

• CA1839 and CA1840 added in Add analyzers/fixers for Environment.ProcessPath and CurrentManagedThreadId roslyn-analyzers#4909

• CA1841 added in (1/4) Issue 35343 - Replace Dictionary<,>.Keys.Contains with Dictionary<,>.ContainsKey roslyn-analyzers#4687. Documentation PR Ca1841 #23887

• CA1845 added in (3/4) Use Span-Based String Concat Analyzer and Fixer roslyn-analyzers#4764. Documentation PR CA1845 #24270

• CA1844 added in (2/4) Override Stream ReadAsync/WriteAsync Analyzer roslyn-analyzers#4726. Documentation PR CA1844 #24278

• CA1846 added in (4/4) Prefer 'AsSpan' over 'Substring' analyzer roslyn-analyzers#4806. Documentation PR Ca1846 #24325

• CA1847 added in Add Analyzer & Codefix - CA1847 - Use String.Contains(Char) instead of String.Contains(String) with single characters roslyn-analyzers#4908. Documentation PR Added documentation for new rule CA1847 - Use string.Contains(char) w… #23377

• CA1850 (Documentation PR Add CA1850 documentation #26634)

• CA2018 added in Buffer.BlockCopy Analyzer roslyn-analyzers#5242.

• CA2250 added in Use cancellation token throw if cancellation requested roslyn-analyzers#4864. Documentation PR Ca2250 #24324

• CA2251 added in #45552 use string equals over string compare roslyn-analyzers#5116. Documentation PR Ca2251 #24463.

• CA2255 added in Implement the ModuleInitializerAttributeShouldNotBeUsedInLibraries analyzer roslyn-analyzers#5347.

See https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/RulesMissingDocumentation.md.

CAxxxx docs guide.

Tagging @buyaa-n @stephentoub @ryzngard @jkoritzinsky @NewellClark @MeikTranel who implemented these in case any of you wants to open a docs PR.

[mavasani]

Thank you so much for creating this doc isssue @Youssef1313! You are always one step ahead of us :-)

[mavasani]

Also tagging @jeffhandley as an FYI

[jeffhandley]

Adding @buyaa-n and @carlossanlop for their tracking.

[MeikTranel]

@Youssef1313 can you add #23377 to the CA1847 Rule point? I've reopened the PR a while ago.

[mikeKuester]

Visual Studio 2022 shows CA2254 warnings, but the link is broken? It is also missing in https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/
But if I look in the issue, it should be already merged? "CA2254 added in Enabled logging analyzer on new repo roslyn-analyzers#5244."

[Youssef1313]

@mikeKuester The PR that's merged is that product PR. The docs PR isn't yet created. cc @maryamariyan

[mikeKuester]

@Youssef1313 Ok, it is a little bit strange, that a new analyser is deployed without an explanation. :(
At least from my user perspective.

[pcartwright81]

@Youssef1313 Ok, it is a little bit strange, that a new analyser is deployed without an explanation. :( At least from my user perspective.

Is this analyser live in main or or preview?

[Eli-Black-Work]

It's been live in non-preview VS2022 for a while 🙂

[mikeKuester]

I didn't install the VS2022 preview, so it's live since the first stable VS2022 version. (actual 17.0.5)

[Youssef1313]

The issue is probably near to be fixed. See #27885

[Eli-Black-Work]

Yay! 🎉