Update C# onEnterRules to account for documentation comments #242121
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.
Resolves dotnet/vscode-csharp#8025
A couple months ago it looks like, an onEnter rule was added to 'continue' a comment if enter is pressed inside a line comment. This is generally fine, however it causes problems when writing documentation comments which use
///
instead. You end up with something like the following (see also video in linked issue):This PR modifies the line comment enter rule to avoid inserting the line comment if it detects a triple comment.
Additionally, I added an on enter rule for
///
to auto insert///
when hitting enter anywhere inside a documentation comment. Currently that is handled in the server side of the C# extension, but it can be slow and finicky. Better to just have the client handle it via an on enter rule.This shows the new behavior: