Fix crash on Javadoc comments before package/import (#143) - #155
Merged
Merged
Conversation
SyntaxKind.XmlComment is not valid for SyntaxFactory.SyntaxTrivia, and XML doc comments cannot attach to a file header or a using directive. Render Javadoc as a normalized block comment in those positions instead.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #143.
Problem
GetCommentInfomaps aJavadocCommenttoSyntaxKind.XmlComment, but that kind is not valid forSyntaxFactory.SyntaxTrivia, so any Javadoc attached to the compilation unit, thepackagedeclaration, or animportdeclaration crashed withSystem.ArgumentException: kind.AddCommentsTriviasalready special-casesXmlCommentand converts it to a///doc comment, but that isn't right here either — XML doc comments can't attach to a file header or a using directive, and doing so produces mangled output like<summary>foo</summary> using java.List;.Fix
Added
CreateNonMemberCommentTrivia, used byAddPackageCommentsandAddUsingComments, which renders Javadoc as a normalized block comment in those positions.FormatAsBlockCommentstrips the leading*from each line and trims blank leading/trailing lines, so the output is the clean form requested in the issue rather than the ragged raw content:Non-Javadoc comments keep their existing behavior.
Testing
Written TDD — the two new tests in
CommentTests.cs(Javadoc beforepackage, Javadoc beforeimport) each reproduced theArgumentExceptionbefore the fix and assert the expected output after. Full suite: 258 passed.