Improve handling of comments and doc comments #48
Conversation
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
Doc comments are now properly formatted with `gq` and `J`. For example, on this input text: ``` /// one /// two ``` pressing `J` on the top line used to result in `/// one / two`, and now results in `/// one two`. Conversely, on this input text: ``` /// this long line exceeds the text width ``` pressing `gqgq` with a `textwidth` of 20 now yields: ``` /// this long line /// exceeds the text /// width ``` instead of: ``` /// this long line //exceeds the text //width ``` Furthermore, adding a new line to an existing comment, by pressing `o` in normal mode or `Enter` in insert mode, now automatically inserts the appropriate comment leader (`//` or `///`). wchargin-branch: comment-doc-and-leader wchargin-source: 93a80fff55389ecf7f5a0ae67850bdc40b5f0346
|
@wchargin how about also accommodating the |
Go for it! I personally don't use that natspec style and am not super |
|
Hey @wchargin, I merged this PR in our maintained fork! |
prinz40
approved these changes
Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Doc comments are now properly formatted with
gqandJ. For example,on this input text:
pressing
Jon the top line used to result in/// one / two, and nowresults in
/// one two. Conversely, on this input text:pressing
gqgqwith atextwidthof 20 now yields:instead of:
Furthermore, adding a new line to an existing comment, by pressing
oin normal mode or
Enterin insert mode, now automatically inserts theappropriate comment leader (
//or///).wchargin-branch: comment-doc-and-leader