RCS0036 without GenerateDocumentationFile shows error
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 294
- Avg merge
- 2h 30m
- Merged PRs (30d)
- 4
Description
Having a project without GenerateDocumentationFile property set to true and RCS0036 active shows an error.
**Steps to reproduce**
1. Have the GenerateDocumentationFile missing or set to false in the csproj
```
net8.0
false
```
2. Have a class with documentation on the properties
```
///
/// Test
///
public class TestClass
{
///
/// Create instance
///
public TestClass(string p1, string p2)
{
P1 = p1;
P2 = p2;
}
///
/// P1
///
public string P1 { get; }
///
/// P2
///
public string P2 { get; }
}
```
3. Build and see the error
```
error RCS0036: Remove blank line between single-line declarations of same kind
```
Contributor guide
Research direction
Start by reproducing issue 1608 with the shown C# project and class, using RCS0036 with GenerateDocumentationFile missing and set to false. Trace the RCS0036 analyzer and its tests to determine why it reports the blank-line error in these configurations; done means the build no longer reports RCS0036 when documentation generation is disabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100