dotnet / dotnet/roslyn

Inellisense popup for XML documentation should honor Whitespace in ALL elements

Open
#74,569 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-IDE
Dominant language
C#
Stars
20.7k
Forks
4.3k
PR merge metrics
PR metrics pending

Description

Version Used:
VS2022 17.10.4

Steps to Reproduce:

/// <summary>Blah Blah Blah...</summary>
/// <remarks>
/// <para>Description of the following outline:</para>
/// 1. First point<br/>
/// 2. Second point<br/>
/// 3. Third point with indented sub point<br/>
///     1. Indented Sub point<br/>
/// 4. fourth point<br/>
/// </remarks>

Expected Behavior:
Inline whitespace (especially leading space for subpoint 3.1) would be honored and shown in IDE

Actual Behavior:
All leading whitespace is trimmed and left aligned in the popup (Looks terrible and harder to read).

Creating Tables or outlined text is a Major PITA with doc comments. Ideally it would honor some form of Markdown, which looks and renders fine even if ignored as markdown (so long as whitespace is honored)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in Visual Studio 2022 17.10.4 using the C# XML documentation snippet from the report. Start by tracing how XML documentation is rendered in the IntelliSense popup; the work is done when leading whitespace, especially the indented subpoint, is preserved and the resulting outline is easier to read.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
developer-experience, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.