dotnet/roslyn

Pasting generic type names in doc comments should escape '<' and '>'

Open

#19,197 opened on May 3, 2017

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-IDEhelp wanted

Description

I find myself often passing type names into <see cref=""/> constructs, it would be so helpful if the '<' and `>' would be automatically replaced with '{' and '}'.

Contributor guide

Tech stack
csharp
Domain
documentationdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# experienceDoc comment syntaxRoslyn compiler internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue involves modifying the code that handles pasting type names into doc comment <see cref> constructs. Look at the code in the Roslyn repository that processes documentation comments, possibly in `src/Compilers/CSharp/Portable/Syntax/DocumentationCommentSyntax.cs` or related files. The goal is to automatically escape '<' and '>' with '{' and '}' when pasting. Consider adding a transformation in the paste handler or in the doc comment generator. No linked PRs or comments provide further guidance.