Skip to content

Commit 988017f

Browse files
committed
Add proper documentation page for SA0000Roslyn7446Workaround
1 parent 24bff53 commit 988017f

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

StyleCopAnalyzers.sln

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "documentation", "documentat
3636
documentation\Configuration.md = documentation\Configuration.md
3737
documentation\EnableConfiguration.md = documentation\EnableConfiguration.md
3838
documentation\KnownChanges.md = documentation\KnownChanges.md
39+
documentation\SA0000Roslyn7446Workaround.md = documentation\SA0000Roslyn7446Workaround.md
3940
documentation\SA1000.md = documentation\SA1000.md
4041
documentation\SA1001.md = documentation\SA1001.md
4142
documentation\SA1002.md = documentation\SA1002.md
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## SA0000Roslyn7446Workaround
2+
3+
<table>
4+
<tr>
5+
<td>TypeName</td>
6+
<td>SA0000Roslyn7446Workaround</td>
7+
</tr>
8+
<tr>
9+
<td>CheckId</td>
10+
<td>SA0000</td>
11+
</tr>
12+
<tr>
13+
<td>Category</td>
14+
<td>Special Rules</td>
15+
</tr>
16+
</table>
17+
18+
## Cause
19+
20+
Workaround incomplete diagnostics in Visual Studio 2015 Update 1.
21+
22+
## Rule description
23+
24+
Visual Studio 2015 Update 1 contains a bug which can cause diagnostics to occasionally not display in the Errors window.
25+
When this occurs, it is impossible to use the code fixes to address style violations reported during a build. This
26+
analyzer works around the bug [dotnet/roslyn#7446](https://github.com/dotnet/roslyn/issues/7446).
27+
28+
When this analyzer is enabled, all diagnostics will eventually be reported in the Error window, but the performance of
29+
the analyzers is reduced. The rule is disabled for maximum performance, but can be enabled if users notice errors
30+
appearing during a build but not while editing, and they wish to use the code fixes to correct them.
31+
32+
Note that some situations are not affected by the bug:
33+
34+
* When building a project, all relevant warnings are reported even if this rule is disabled.
35+
* The various Fix All operations work properly for the selected scope, even if only a subset of the violations are
36+
appearing in the Errors window.
37+
38+
## How to fix violations
39+
40+
This analyzer does not report any diagnostics.
41+
42+
## How to suppress violations
43+
44+
This analyzer does not report any diagnostics.

0 commit comments

Comments
 (0)