dotnet / dotnet/docfx

[Feature Request] Space missing betweeen: `///` and `<summary>`

Open
#9,848 1 comment 0 reactions 0 assignees View on GitHub
dotnet: xml-comment
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

**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 ``.
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 `/// This code is great` we had `///This code is great`.

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.