Add documentation comment creation to the FormatAfterKeystrokeService #2023
Conversation
IDocumentationCommentSnippetService was recently moved down to the Features layer, which means omnisharp can now take advantage of it and generate documentation comment snippets on typing. There are a couple of caveats: 1. LSP's "/onTypingFormat" endpoint has no support for setting the cursor location after format, which means that the cursor ends up after the inserted block. This is fine for newlines inside doc comments, but awkward for the initial expansion. However, unless we want to add special support with a custom endpoint, we can't get around this (the custom endpoint is how Roslyn does it). 2. The service itself is still internal, so I had to add a few new reflection points. Server-side of dotnet/vscode-csharp#8. It also needs a vscode change, but it's a one-line change I'll submit later after we get this merged and I can write some integration tests.
| static DocumentationCommentSnippetService() | ||
| { | ||
| var iDocumentationCommentSnippetServiceType = typeof(CompletionItem).Assembly.GetType("Microsoft.CodeAnalysis.DocumentationComments.IDocumentationCommentSnippetService"); | ||
| s_getDocumentationCommentSnippetOnCharacterTyped = iDocumentationCommentSnippetServiceType.GetMethod(nameof(GetDocumentationCommentSnippetOnCharacterTyped)); |
There was a problem hiding this comment.
I saw that there is also GetDocumentationCommentSnippetOnCommandInvoke, I think it is used in VS when you invoke "insert comment" command from insert snippet feature. we may also want to expose it in the future
|
I'd like to add that the current popular solution to do this in VS Code is to use |
|
It seems that this feature requires us to set That is unfortunate as many people (me included) don't like it - it ruins one's coding workflow, and besides there are many formatting tools that handle that sort of thing. Is it possible for this feature to work without that setting? (BTW: the |
No, it is not. Not and be compatible with LSP. We need a new LSP feature to make it more generally available. |
|
also, |
|
Thank you for explaining. I didn't realize that plugin was that aggressive!
In vscode or omnisharp? And is there already an issue tracking this, or do you want me to open one? |
Neither, in LSP. And I imagine there's an open proposal somewhere for an LSP endpoint that could accomplish this, but I haven't really looked. |
|
@333fred Well then it's obviously beyond my understanding, so I wouldn't even know how to write the issue. 😄 I hope you'll find some time to investigate. Until then thanks for this PR, it's a decent approach for now. |
IDocumentationCommentSnippetService was recently moved down to the Features layer, which means omnisharp can now take advantage of it and generate documentation comment snippets on typing. There are a couple of caveats:
Server-side of dotnet/vscode-csharp#8. It also needs a vscode change, but it's a one-line change I'll submit later after we get this merged and I can write some integration tests.