Skip to content

Fix SA1514: Do not report when documenting types declared in the global namespace #3863

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix SA1514: Do not report when documenting types declared in the global namespace #3863

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6673e09
Added new logic to skip SA1514 when documenting types declared in the…
MattFromRVA Jun 26, 2024
1ba0ce3
Updated code and tests.
MattFromRVA Jul 2, 2024
cd99e2f
Added more tests
MattFromRVA Jul 2, 2024
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
18 changes: 18 additions & 0 deletions StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1514UnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1151,5 +1151,23 @@ public enum TestEnum

await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}

[Fact]
[WorkItem(3849, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3849")]
public async Task TestClassInGlobalNamespaceAsync()
{
var testCode = @"
/// <summary>
/// X.
/// </summary>
public class TestClass
{
}
";

var expected = DiagnosticResult.EmptyDiagnosticResults;

await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}
}
}
12 changes: 12 additions & 0 deletions ...yleCop.Analyzers/LayoutRules/SA1514ElementDocumentationHeaderMustBePrecededByBlankLine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,18 @@ private static void HandleDeclaration(SyntaxNodeAnalysisContext context)
// no leading blank line necessary at start of scope.
return;
}

// Logic to handle global namespace case
if (prevToken.IsKind(SyntaxKind.None))
{
// Check if the node is the first non-trivia element in the file
var firstToken = context.Node.SyntaxTree.GetRoot().GetFirstToken();
if (firstToken == context.Node.GetFirstToken())
{
// Node is the first element in the global namespace
return;
}
}
}

context.ReportDiagnostic(Diagnostic.Create(Descriptor, GetDiagnosticLocation(documentationHeader)));
Expand Down