Skip to content

Fix issue with disappearing newlines after multiline documentation comment #77521

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

Merged
jjonescz merged 5 commits into from
Mar 25, 2025
Merged

Fix issue with disappearing newlines after multiline documentation comment #77521

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
67cf301
Fix issue with disappearing newlines after multiline documentation co…
dgounaris Mar 11, 2025
88cea22
Fix formatting issues
dgounaris Mar 11, 2025
4c5889f
Convert LineBreaksAfterLeading to local function
dgounaris Mar 12, 2025
e23e582
Update function syntax to match conventions
dgounaris Mar 25, 2025
aac7fa3
Fix compilation errors
jjonescz Mar 25, 2025
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
21 changes: 19 additions & 2 deletions src/Compilers/CSharp/Portable/Syntax/SyntaxNormalizer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,14 @@ public override SyntaxToken VisitToken(SyntaxToken token)

var depth = GetDeclarationDepth(token);

var lineBreaksAfterLeading = LineBreaksAfterLeading(token);
tk = tk.WithLeadingTrivia(RewriteTrivia(
token.LeadingTrivia,
depth,
isTrailing: false,
indentAfterLineBreak: NeedsIndentAfterLineBreak(token),
mustHaveSeparator: false,
lineBreaksAfter: 0));
lineBreaksAfter: lineBreaksAfterLeading));

var nextToken = this.GetNextRelevantToken(token);

Expand All @@ -118,6 +119,22 @@ public override SyntaxToken VisitToken(SyntaxToken token)
lineBreaksAfter: lineBreaksAfter));

return tk;

int LineBreaksAfterLeading(SyntaxToken syntaxToken)
{
if (syntaxToken.LeadingTrivia.Count < 2)
{
return 0;
}

if (syntaxToken.LeadingTrivia[^2].IsKind(SyntaxKind.MultiLineDocumentationCommentTrivia) &&
syntaxToken.LeadingTrivia[^1].IsKind(SyntaxKind.EndOfLineTrivia))
{
return 1;
}

return 0;
}
}
finally
{
Expand Down Expand Up @@ -1247,7 +1264,7 @@ private static bool EndsInLineBreak(SyntaxTrivia trivia)
}
else
{
return IsLineBreak(node.GetLastToken());
return !node.IsKind(SyntaxKind.MultiLineDocumentationCommentTrivia) && IsLineBreak(node.GetLastToken());
}
}

Expand Down
20 changes: 20 additions & 0 deletions src/Compilers/CSharp/Test/Syntax/Syntax/SyntaxNormalizerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3790,6 +3790,26 @@ void goo()
"}");
}

[Fact, WorkItem("https://github.com/dotnet/roslyn/issues/76856")]
public void TestNormalizeDocumentationMultiLineCommentsWithTrailingNewline()
{
TestNormalizeStatement("""
/**
*
* Escape XML special characters
*/
private String EscapeXML(String str)
{
""", """
///
///
/// Escape XML special characters
//////
Copy link
Member

@jjonescz jjonescz Mar 24, 2025

Choose a reason for hiding this comment

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

Why do we generate so many slashes here?

Copy link
Member

@333fred 333fred Mar 24, 2025

Choose a reason for hiding this comment

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

I thought the same thing, but that generation is outside the scope of this request, imo. The current behavior has just as many slashes, but misses the newline after them so it ends up as //////private String EscapeXML(String str).

Copy link
Contributor Author

@dgounaris dgounaris Mar 25, 2025

Choose a reason for hiding this comment

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

Exactly, I didn't modify the resulting slashes because I didn't know if that was the expected result from a normalization point of view.
For future reference, the reason these additional slashes exist has to do with the fact that the comment ending token is padded with a whitespace, and both the padding and the comment ending token get replaced by ///.

If the test instead had input of

/**
 * 
 * Escape XML special characters
*/

there would be 3 slashes only.

If you think this should be fixed and padding should be ignored when replacing with slashes at comment end, let me know. I can pick this up as a follow-up improvement PR.

private String EscapeXML(String str)
{
""");
}

[Fact]
public void TestNormalizeEOL()
{
Expand Down