Add "Add missing XML documentation" codefix #1108
Conversation
dawedawe
changed the title
|
|
||
| let private tryGetExistingXmlDoc (pos: FSharp.Compiler.Text.Position) (xmlDoc: PreXmlDoc) = | ||
| let containsPosAndSummaryPresent (xd: PreXmlDoc) = | ||
| let d = xd.ToXmlDoc(false, None) |
There was a problem hiding this comment.
I was going to ask about doing this work, but then I remembered I raised dotnet/fsharp#14882 already to track it :)
There was a problem hiding this comment.
I've put it on my list and will have a go at it in the next couple of weeks.
| testCaseAsync "not applicable for function without summary" | ||
| <| CodeFix.checkNotApplicable | ||
| server | ||
| """ | ||
| /// some comment$0 | ||
| let f x y = x + y | ||
| """ | ||
| Diagnostics.acceptAll | ||
| selectCodeFix |
There was a problem hiding this comment.
How hard would it be to make this case work? It'd be really nice to have one gesture to go from 'simple' xmldoc to 'full' xmldoc.
There was a problem hiding this comment.
Oh, I'm afraid there was some misunderstanding on my side. I thought your goal was to have a two step approach like:
- convert tripple slash comment to xml comment
- add missing xml tags
I'll take a look. Shouldn't be too much work.
There was a problem hiding this comment.
It's in.
Recording.2023-04-26.233807.mp4
|
Nicely done, @dawedawe - thank again for pushing on this area :) |
WHAT
🤖 Generated by Copilot at c1d8742
This pull request adds a new code fix feature for adding missing XML documentation comments to F# code. It implements the logic for the code fix in a new module
AddMissingXmlDocumentation.fsand adds tests for it inTests.fs. It also registers the code fix function in the two language server typesAdaptiveFSharpLspServerandFSharpLspServerso that it can be invoked by the code action request.🤖 Generated by Copilot at c1d8742
📝🛠️🧪
WHY
As discussed here, another code fix should handle the insertion of missing xml tags. It's applicable if the cursor is inside of an xml comment with a summary tag above an AST element for which the FCS gives a signature.
Recording.2023-04-23.191411.mp4
HOW
🤖 Generated by Copilot at c1d8742
AddMissingXmlDocumentationthat implements a code fix for adding missing XML documentation to F# symbols (link)AddMissingXmlDocumentation.fixfunction as a code fix for theAdaptiveFSharpLspServerandFSharpLspServertypes, which handle code action requests from the language server protocol (link, link)AddMissingXmlDocumentationcode fix in theCodeFixTests.Testsmodule, using theCodeFix.checkandCodeFix.checkNotApplicablefunctions to verify the expected behavior (link)addMissingXmlDocumentationTestsfunction as part of thetestsfunction, which is the main entry point for the code fix tests (link)