dotnet/roslyn

Escaping out of a cref tag is very difficult

Open

#10,015 opened on Mar 23, 2016

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

Description

Consider I'm typing in the following context:

typing

There is no good way to escape out of this tag without hitting the right arrow key a few times. Possible fixes include:

  1. We set up the brace matching context for the " and /> somehow so you can overtype them
  2. There's some commit gesture when committing an element that jumps the caret out past the end of the element. @DustinCampbell observed that there are some cases where you want space to be committable (notably generics and method signatures), so that "obvious" solution doesn't work.

Contributor guide

Tech stack
csharp
Domain
developer 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#editor extensibility
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Explore the Roslyn editor's handling of XML doc comments, specifically the cref tag auto completion and brace matching. Look into the EditorFeatures project for relevant code that handles typing scenarios. Consider implementing one of the suggested fixes: overtyping the closing delimiter or a commit gesture like pressing Tab to exit the tag. Examine similar features like generic type argument completion for reference.