[Feature Request] Space missing betweeen: ///
and <summary>
#9848
Labels
dotnet: xml-comment
XML comment for .NET API reference docs
///
and <summary>
#9848
Is your feature request related to a problem? Please describe.
I just fixed quite a few instances in our code-base that had documentation comments that were accidentally missing a space between
///
and<summary>
.This leads to the summary being quietly ignored for the docfx output. The docfx, c# compiler and VisualStudio are not warning or complaining about this missing space is any way. The description is simply missing in the rendered docfx output.
So instead of
/// <summary>This code is great</summary>
we had///<summary>This code is great</summary>
.I understand that all available examples contain this space (including in the c# standard).
Describe the solution you'd like
My suggestion would be to be permissive when parsing, and to treat the space as optional.
Describe alternatives you've considered
The alternative solution for this issue would be to issue a "missing documentation" or even better "missing space"-warning. That would also fully satisfy my request.
Additional context
I can provide a sample/repro, but I believe this is a pretty clear request.
I searched the docfx Issues quite a bit, because I thought somebody must have encountered this before. Sorry, if I missed something and this is a duplicate request.
The text was updated successfully, but these errors were encountered: