dotnet/roslyn

Handle user typing Action<T> in a documentation comment

Open

#21,476 opened on Aug 12, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-IDEConcept-Design Debthelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Version Used: 15.3 Preview 7

⚠️ This feature is not ready to implement. It needs design work to understand all the specific cases we're interested in handling.

Steps to Reproduce:

  1. In an XML documentation comment, type Action<T> (as a set of keystrokes, not copy/paste)

Expected Behavior:

<see cref="Action{T}"/>

Actual Behavior:

Action<![CDATA[>]]>

Contributor guide

Research direction
Investigate how the C# parser handles XML documentation comments, specifically the translation of 'Action<T>' to XML. Trace the code path from the IDE typing input to the generated XML snippet.
Tech stack
csharp
Domain
compilers
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#XML documentation comments
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65