Better formatting of inline block-comments #462
Merged
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.
Previously all block-comments were formatted on a separate line, like:
would get formatted as:
After this change the result is more like one would expect:
Only when the block-comment spans multiple lines or is preceded by a newline will it be formatted as before: on a separate line of its own.
The formatting is still not ideal, but it should work well for most common scenarios. Sometimes the comments don't get nicely padded by spaces on both sides, as one can see in the tests, but these are some pretty odd scenarios, like placing comments between table and column name
table /* */ . /* */ col
, something one really rarely does in real world.